ZAzahlo
Subscriptions

Sandbox only: advance a subscription to its next billing event

Moves the subscription's own dates like a test clock and feeds a synthetic outcome to the real billing handlers, so the real subscription events and customer notices follow. Nothing is charged and no Payment is written. 404 resource_not_available outside the sandbox.

post/api/v1/test-helpers/subscriptions/{id}/advance

Request

  • Base URL
    https://merchant.zahlo.eu
  • Auth
    API key in header x-api-key

Path parameters

idstring required

The resource identifier returned by the merchant API.

Request body

to'trial_will_end' | 'renewal_succeeded' | 'renewal_failed' | 'renewal_requires_action' | 'sepa_returned' | 'period_end' required

Response

Successful response

idstring required
object'subscription' required
livemodeboolean
createdAtstring date-time
customerIdstring required
priceIdstring required
quantityinteger
status'incomplete' | 'trialing' | 'active' | 'past_due' | 'paused' | 'cancelled' required
currencystring required
amountMinorinteger required

The current or next period's charge, after discount.

couponIdstring nullable
discountEndsAtstring date-time nullable
paymentMethodIdstring nullable
rail'card' | 'sepa_debit'
trialEndstring date-time nullable
currentPeriodStartstring date-time nullable
currentPeriodEndstring date-time nullable
cancelAtPeriodEndboolean required
cancelledAtstring date-time nullable
cancellationReason'requested' | 'payment_failed' nullable
pastDueSincestring date-time nullable
latestPaymentIdstring nullable
prorationMinorinteger

Proration for an upgrade or seat increase, added to the next period's charge.

metadataobject

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

Changes

No recorded changes to this operation across all 1 revision of this API.