Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Billing__subscription

Current PGW subscription period (start/end) for the tenant, or null when none exists. Requires a signed-in staff user. Needs the `billing__Checkout` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYbilling__subscription: PgwSubscriptionDto

Current PGW subscription period (start/end) for the tenant, or null when none exists. Requires a signed-in staff user. Needs the billing__Checkout read permission. Send the x-tenant header (the gateway sets it from your API key).

Returns

  1. billing__subscription
billingCycleDays?Float
cancelScheduledAt?String
currentPeriodEnd*String!
currentPeriodStart*String!
planKey*String!
status*String!
Example Request
query Billing__subscription {  billing__subscription {    billingCycleDays    cancelScheduledAt    currentPeriodEnd    currentPeriodStart    planKey    status  }}
Example Response
{  "data": {    "billing__subscription": {      "billingCycleDays": 10.5,      "cancelScheduledAt": "string",      "currentPeriodEnd": "string",      "currentPeriodStart": "string",      "planKey": "string",      "status": "string"    }  }}

WhatsappChatCredentials

Previous Page

Blog QUERY

Authenticated · x-tenant · Auth rules: @storeos/rbac-catalog Requires a signed-in staff user. Needs the `Blogs` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).