ZAzahlo
Subscriptions

Pause a subscription

Pause a subscription. Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

post/api/v1/subscriptions/{id}/pause

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.

Headers

Idempotency-Keystring

Retry-safe key for create operations.

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.