Sign in

v1

latestOpenAPI 3.0.32026-07-24513934.5 KB
Subscriptions

Simulate subscription

Trigger subscription billing events in test mode.

post/v1/subscriptions/{id}/simulate

Path parameters

idstring required

Request body

event'pre_charge_reminder' | 'due_charge' | 'payment_failed' | 'retry_due' | 'retry_failed_cancel' | 'manual_invoice_due' | 'manual_overdue_reminder' required
redirectUrlstring

Redirect URL used when the simulation creates a payment or recovery checkout flow.

Response

Subscription event simulated.

statusboolean
simulated'pre_charge_reminder' | 'due_charge' | 'payment_failed' | 'retry_due' | 'retry_failed_cancel' | 'manual_invoice_due' | 'manual_overdue_reminder'
backend'temporal' | 'inline'

Present for due_charge and retry_due simulations.

workflowIdstring

Present when the simulation starts a Temporal workflow.

subscriptionIdstring
invoiceobject
paymentUrlstring
reminderstring
subscriptionStatusstring
isActiveboolean
retryCountnumber
{"stackTrail":"components:schemas:SubscriptionSimulationResponse:properties:result","oasType":"schema","type":"unknown","description":"Inline charge result for due_charge and retry_due when Temporal is disabled."}