Integrate with third-party payment processors

Create a Stripe customer

First, create a blank Customer object on Stripe.

curl -X POST https://api.stripe.com/v1/customers \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"

Create a subscription

Next, create a Subscription and set the collection_method to send_invoice. This setting doesn’t require a Stripe payment method and generates Invoices that must be paid directly instead. Set the days_until_due parameter to the number of days an unpaid invoice remains open before your configured failed payment logic activates. You’re responsible for retrying failed payments on the third-party processor, and you must set a long enough time for days_until_due so that any recovery workflows you implement have time to complete.

curl https://api.stripe.com/v1/subscriptions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "items[0][price]"=
{{PRICE_ID}} \
  -d customer=
{{CUSTOMER_ID}} \
  -d collection_method=send_invoice \
  -d days_until_due=30

Present the amount to the user for payment

Third-party payments don’t work with Stripe Checkout or Elements. You must build a checkout flow that uses the third party to create a valid payment method, but uses Stripe to determine billable amounts. To determine the amount to charge in the checkout flow, retrieve the initial invoice generated by the subscription.

Collect payment method details Third party

Follow the instructions from the third-party processor to collect payment method details from customers. Make sure to set up payment methods for use in future or off-session transactions.

The output of this step varies by processor. Some third-party processors provide a payment method token that you use to generate payments on that processor.

Update the Customer object

Update the Customer object created in the first step of the subscription creation flow. For convenience, store non-sensitive third-party tokens as metadata on the Customer object.

Remember to disable the Send finalized invoices and credit notes to customers option before setting the email property on the Customer.

curl https://api.stripe.com/v1/customers/
{{CUSTOMER_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d description="Third-party payment customer" \
  -d "metadata[third_party_customer_id]"={{THIRD_PARTY_CUSTOMER_ID}} \
  -d "metadata[third_party_payment_method_id]"={{THIRD_PARTY_PAYMENT_METHOD_ID}}

Listen for invoice.created webhook events

All invoices (including the first invoice created from a subscription) start in a draft state and trigger invoice.created webhooks. Invoices created by a subscription are automatically finalized after 1 hour to allow time for integrations to modify the draft invoice. You can finalize the invoice manually if you want to skip this delay.

Invoice finalization triggers an invoice.finalized event, which you should listen for to trigger payments on the third-party processor.

Process payments Third party

Follow the instructions from the third-party processor to collect payments for the amounts represented on each invoice using the tokens stored on the associated Customer object. This might include listening to webhooks from the third party for notifications of successful payments.

Mark the Stripe invoice as paid out-of-band

When payment on the third party processor is successful, mark the corresponding invoice as paid_out_of_band.

curl https://api.stripe.com/v1/invoices/
{{INVOICE_ID}}
/pay \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d paid_out_of_band=true

Mark the invoice as paid before the subscription’s payment due date to keep the subscription operating normally. The Subscription object’s days_until_due attribute defines the payment due date.

Cancel subscriptions

To cancel a subscription, remove the third-party payment method details from the Stripe Customer object and your database. Listen for the customer.subscription.deleted event and delete any tokens related to the canceled subscription.

Third-party payment cancellation Third party

Some third-party processors allow end customers to cancel billing agreements directly. If the processor allows this, listen for any associated events and then cancel the subscription on Stripe.

Refunds and disputes Third party

You’re responsible for processing refunds and disputes originating from the third-party processor. To maintain accurate accounting data, use Credit Notes to adjust the amounts on issued invoices to log refunds. Create a Credit Note, and set the out_of_band_amount to the refunded amount.

Switch between third-party payments and Stripe

To switch a customer from a third-party processor to Stripe:

1. Collect a new payment method for the customer by setting up future payments or using the customer portal.
2. Update the subscription collection_method from send_invoice to charge_automatically and set the new payment method as the default_payment_method.
3. Delete any existing third-party payment method tokens.

Retries

You must handle any recovery of failed third-party payments yourself. Stripe doesn’t have any visibility into the state of third-party payments until you mark an invoice as paid.

Taxes

Stripe Tax automatically adds the correct tax amounts to invoices as long as you set a billing postal code or IP address when updating the Customer object after checkout.

Partial payments

We don’t support partial payments on out_of_band invoices. In the event of a partial payment, use a Credit Note to adjust the original invoice, and then manually generate a new invoice for any remaining balance.