Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Change plan on a customer subscription
Move a web subscription onto another recurring catalog plan.
Move a web subscription onto another recurring catalog plan.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription:changePlan - Scope
billing:write - Effect
write— a successful call changes state. - Collection customer_subscriptions
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The subscription to change. Required. |
product | string | The key of the catalog product to move to. Required. |
price | string | The key of the product's recurring price (for example monthly or yearly). Optional when the product has one recurring price. |
proration_behavior | ProrationBehavior | How the change is billed; unspecified is create_prorations. One of create_prorations, none, always_invoice. |
validate_only | bool | Run every check and answer the subscription as it would read, without changing anything. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/customer_subscriptions/{customer_subscription}. |
uid | string | csb_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
subject | Subject | Who holds it. Output only. |
source | string | stripe, app_store, or google_play. Output only. |
processor_subscription_id | string | The processor's subscription id. Output only. |
status | string | trialing, active, past_due, paused, canceled, unpaid, incomplete, or incomplete_expired, as the processor reports it. Output only. |
items | LineItem[] | The prices, by lookup key, and their quantities. Output only. |
current_period_end_time | timestamp | The end of the paid period. Output only. |
cancel_at_period_end | bool | Whether it ends at current_period_end_time instead of renewing. Output only. |
trial_end_time | timestamp | The end of the trial, when there is one. Output only. |
metadata | struct | The checkout's metadata. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Subject
| Field | Type | What it is |
|---|---|---|
end_user | string | An end user's id (Sylphx Auth, or the app's own OIDC issuer). One of the kind group. |
customer_organization | string | A customer organization's id. One of the kind group. |
#LineItem
| Field | Type | What it is |
|---|---|---|
price | string | The price's lookup key. Required. |
quantity | int32 | How many; default 1. Seats for a per-seat or family price. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.UNAVAILABLE— The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_subscriptions/customer-subscription:changePlan" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"product":"…"}'