Account

Get authenticated customer's active subscription

Retrieve your active subscription: plan, status, and current billing period. Returns 404 if the account has no active subscription.

Requires the account:read scope.

get/v1/account/subscription

Request

Base URL
https://api.platform.soax.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/soax/apis/soax-api/docs/v1/account/subscription/get.ts
A function with typed inputs. Its response is checked against the schema.

Successful Response

idstring nullable

planstring nullable

statusstring required

created_atstring date-time required

started_atstring date-time required

current_billing_period_start_datestring date-time nullable

current_billing_period_end_datestring date-time nullable

end_datestring date-time nullable

No recorded changes to this operation across all 1 revision of this API.