Statuses for Subscription API
Subscription
Status | Description |
---|---|
incomplete | Initial status of the subscription. The customer must successfully process the first payment, which will require card payment authentication, to activate the subscription. |
incomplete_cancelled | If the subscription remains unpaid within 24 hours, PayMongo will automatically cancel the subscription. You need to create a new subscription if the customer wants to resubscribe. This status allows you to track subscriptions that were not successfully paid after a customer subscribes to a plan. |
active | The subscription's invoices were all successfully paid. At this point, you can start providing the service to your customer. |
past_due | The subscription's latest invoice payment failed due to various reasons (e.g. expired card, insufficient funds, card provider error, etc). An automatic payment will be attempted the following day (maximum of 3 automatic retries). Next invoice will still be automatically generated. If the customer wants to initiate a payment, you can manually trigger a request using the Pay an Open Invoice endpoint to pay the latest invoice. |
unpaid | The subscription has at least 1 invoice payment that still failed after 3 automatic retries. Next invoice will still be automatically generated. If the subscription is unpaid, we recommend you temporarily stop providing the service to your customer. However, if the customer wants to initiate a payment, you can manually trigger a request using the Pay an Open Invoice endpoint to pay the latest invoice. |
cancelled | The subscription has been canceled. No new invoice will be generated and no automatic payment will be attempted. If there is an existing invoice with status open , it will still await payment. |
Invoice
Status | Description |
---|---|
draft | Initial status of the invoice. The invoice amount can still be updated using the Create an Invoice Line Item endpoint. |
open | The invoice is finalized and is unpaid. The invoice is automatically updated to this status 12 hours after it is created. |
paid | The invoice has been paid. |
void | The invoice has been canceled. |
Updated 10 months ago