Bloss Docs

The brand's subscription

Developers
GET
/brands/{brandId}/subscription

Agency owner only. The brand's plan and billing state as the agency's Billing page shows it: the plan it's on, billing status, when it renews or cancels, a plan switch scheduled for the next renewal, and when complimentary access ends. No prices, card details or payment-processor ids.

Authorization

bearerAuth billing:read
headerAuthorizationBearer <token>

Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, recruitment:read, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read.

Scope: billing:read

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length

Response Body

Success.

application/json
  1. response
plan*|

The plan the brand is on; null when it has no active plan.

planName*string|null
subscribedPlan*|

The plan the subscription bills at; null without a subscription. Can differ from plan during complimentary access.

billingStatus*string

"active", "past_due", "incomplete" or "canceled".

hasSubscription*boolean
renewsAt*|

Next renewal (ISO-8601); null when cancelling or unknown.

cancelsAt*|

When the subscription ends, if it's set to cancel (ISO-8601).

complimentaryUntil*|

When complimentary access ends (ISO-8601); billing starts then if subscribed.

scheduledChange*|

A plan switch that takes effect at the next renewal.

curl -X GET 'https://example.com/api/v1/brands/string/subscription'
{  "plan": "string",  "planName": "string",  "subscribedPlan": "string",  "billingStatus": "string",  "hasSubscription": true,  "renewsAt": "string",  "cancelsAt": "string",  "complimentaryUntil": "string",  "scheduledChange": {    "plan": "string",    "planName": "string",    "effectiveAt": "string"  }}

Was this page helpful?

List open account alerts GET

Open alerts about creators' social accounts, newest first: a handle that changed, or a profile that can't be found. The handle on file is never changed automatically; an admin applies or dismisses each alert in the app.

List support tickets GET

The support tickets creators sent the brand, newest first, as on Support Tickets. Filter by `status`.