Skip to main content
POST
Typescript (SDK)
Moves one of a customer’s plans between entities, from an entity to the customer, or from the customer to an entity. Nothing is charged or refunded, and the Stripe subscription doesn’t change. Set at least one of from_entity_id or to_entity_id. Leaving one out means the customer level.
If the plan has a quantity above 1, one unit moves and the rest stay where they are. The destination isn’t checked for an existing plan in the same group.
Plans with license pools can’t be transferred.

Body Parameters

Response

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version
string
default:2.6.0
required

Body

application/json
customer_id
string
required

The ID of the customer whose plan to transfer.

plan_id
string
required

The ID of the plan to transfer.

from_entity_id
string | null

The entity to move the plan from. Omit to move a customer-level plan.

to_entity_id
string | null

The entity to move the plan to. Omit to move the plan to the customer level.

customer_plan_id
string | null

The ID of the customer's plan instance, when several instances of plan_id match.

Response

200 - application/json

OK

success
boolean
required