v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB
Subscriptions

Transfer subscription to resource

Transfers a subscription to a different resource ID. Used for multi-resource products where subscriptions apply to specific entities like websites or apps.

post/api/v1/subscriptions/{id}/transfer

Path parameters

idstring required

The unique identifier of the entity

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

destinationResourceIdstring required

Resource ID to transfer the subscription to

Response

The updated subscription object.