API Reference

User

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Subscriptions

Get User Subscriptions

client.user.subscriptions.get(RequestOptionsoptions?): SinglePage<Subscription { id, currency, current_period_end, 5 more } >

GET/user/subscriptions

Update User Subscription

client.user.subscriptions.update(stringidentifier, SubscriptionUpdateParams { frequency, rate_plan } body, RequestOptionsoptions?): SubscriptionUpdateResponse

PUT/user/subscriptions/{identifier}

Delete User Subscription

client.user.subscriptions.delete(stringidentifier, RequestOptionsoptions?): SubscriptionDeleteResponse { subscription_id }

DELETE/user/subscriptions/{identifier}

ModelsExpand Collapse

SubscriptionUpdateResponse = unknown | string | null

One of the following:

unknown

string | null

SubscriptionDeleteResponse { subscription_id }

subscription_id?: string

Subscription identifier tag.

maxLength32