Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.pagou.ai/llms.txt

Use this file to discover all available pages before exploring further.

Use the subscription status to decide customer access and operational follow-up.

Statuses

StatusMeaningRecommended action
incompletefirst charge or validation did not finishwait for recovery or reconcile
trialingtrial period is activegrant trial access until trial_end
activebilling is currentkeep access active
past_duerenewal failed and retry policy appliesnotify the customer and wait for retry or cancellation
cancel_scheduledcancellation is scheduled for period endkeep access until current_period_end
canceledsubscription is finishedstop future access and billing

Renewals

Pagou renews active and trialing subscriptions when the billing period ends. Successful renewals emit subscription.started after a trial or subscription.renewed for later cycles.

Failed payments

failure_policy controls what happens after a failed renewal:
  • retry_then_cancel: move through retry handling before cancellation.
  • immediate_cancel: cancel when the renewal cannot be collected.
Use retry_offsets_days only when you need explicit retry spacing.

Cancellation

POST /v2/subscriptions/{id}/cancel schedules cancellation at the end of the current period. The subscription becomes cancel_scheduled immediately and later moves to canceled.