This guide explains how the Subscription Init endpoint handles the invoice and payment process, particularly when the first payment attempt is included or omitted from the request.
Purpose of the Endpoint
The endpoint allows users to create a subscription, set a billing schedule and pricing plan, and optionally record the first payment attempt for the initial invoice. This streamlines resource creation, making the process more efficient by handling multiple tasks in a single call.
Invoice and Payment Behavior
- Without First Payment Attempt:
- If no payment attempt details are included in the request, the system will create the invoice, but it will be in “Open” status.
- The invoice’s lifecycle will be processed as usual.
- With Authorized First Payment Attempt:
- If an authorized payment attempt is included in the request, the system will:
- Move the invoice to “Final”.
- Record the payment attempt and mark the invoice as paid.
- With Non-Authorized First Payment Attempt:
- The a payment attempt with a result other than “Authorized” has been provided, the system will:
- Move the invoice to “Final”.
- Record the payment attempt but will not mark the invoice as paid.
This flexibility allows users to either immediately finalize and mark the invoice as paid when payment is made, or to simply create the invoice in “Open” or “Draft” form, leaving it open for later action.
Key Points to Remember
- Including First Payment Attempt: The invoice is finalized and marked as paid.
- Omitting Payment Attempt: The invoice remains in draft or open until further steps are taken.
For full details on the request structure, refer to the API reference, which contains everything you need regarding payloads and response formats.
