Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId
string
required

Organization ID

Example:

"org_8f3kd92ld0"

Response

Default Response

currentPeriod
object
required
shipments
object
required
limits
object
required
addOns
object[]
required

Active add-ons on the subscription

Example:
zippyCredits
object

Zippy credit usage this period (present when the Zippy add-on is enabled)

Example: