Sign in

v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
Subscription Change

Fetch subscription change

This endpoint returns a subscription change given an identifier.

A subscription change is created by including Create-Pending-Subscription-Change: True in the header of a subscription mutation API call (e.g. create subscription endpoint, schedule plan change endpoint, ...). The subscription change will be referenced by the pending_subscription_change field in the response.

get/subscription_changes/{subscription_change_id}

Path parameters

subscription_change_idstring required

Response

OK

idstring required
status'pending' | 'applied' | 'cancelled' required
applied_atstring date-time nullable

When this change was applied.

cancelled_atstring date-time nullable

When this change was cancelled.

expiration_timestring date-time required

Subscription change will be cancelled at this time and can no longer be applied.

change_typestring required

The type of change (e.g., 'schedule_plan_change', 'create_subscription').

effective_datestring date-time nullable

When this change will take effect.

change_optionstring nullable

How the change is scheduled (e.g., 'immediate', 'end_of_subscription_term', 'requested_date').

plan_idstring nullable

The target plan ID for plan changes.

billing_cycle_alignmentstring nullable

Billing cycle alignment for plan changes.