Skip to content
API referenceAPI v1admin-sdk 1.1.52Search docs⌘K
Subscriptions · Billing periods
API reference / Subscriptions

Billing periods

GET/api/v1/billing_subscriptions/:uid/periodsno app scope

Every period of a subscription and whether it was paid.

Path parameters

uidstringrequired

The subscription's uid.

Query parameters

pageinteger

Page number, from 1.

page_sizeinteger

Items per page.

orderstring

Sort, e.g. id desc for newest first.

Headers

Authorizationheaderrequired

Bearer with your secret key, or the merchant's OAuth token.

Returns

The periods, each with start_date, end_date and status.

Errors

200state: "error" with Subscription Not Found.