# Accept subscription payments with PayTo
Learn how to create and charge for a subscription with PayTo.
Use this guide to set up a *subscription* (A Subscription represents the product details associated with the plan that your customer subscribes to. Allows you to charge the customer on a recurring basis) using [PayTo](https://docs.stripe.com/payments/payto.md) as a payment method.
# Stripe-hosted page
> This is a Stripe-hosted page for when api-integration is checkout. View the full page at https://docs.stripe.com/billing/subscriptions/payto?api-integration=checkout.
You can use the [Checkout API](https://docs.stripe.com/api/checkout/sessions.md) to create and confirm a subscription with a prebuilt checkout page.
## Create a product and price [Dashboard]
[Products](https://docs.stripe.com/api/products.md) represent the item or service you’re selling. [Prices](https://docs.stripe.com/api/prices.md) define how much and how frequently you charge for a product. This includes how much the product costs, what currency you accept, and whether it’s a one-time or recurring charge. If you only have a few products and prices, create and manage them in the Dashboard.
This guide uses a stock photo service as an example and charges customers a 15 AUD monthly subscription. To model this:
1. Go to the [Products](https://dashboard.stripe.com/products?active=true) page and click **Create product**.
1. Enter a **Name** for the product. You can optionally add a **Description** and upload an image of the product.
1. Select a **Product tax code**. Learn more about [product tax codes](https://docs.stripe.com/tax/tax-codes.md).
1. Select **Recurring**. Then enter **15** for the price and select **AUD** as the currency.
1. Choose whether to **Include tax in price**. You can either use the default value from your [tax settings](https://dashboard.stripe.com/test/settings/tax) or set the value manually. In this example, select **Auto**.
1. Select **Monthly** for the **Billing period**.
1. Click **More pricing options**. Then select **Flat rate** as the pricing model for this example. Learn more about [flat rate](https://docs.stripe.com/products-prices/pricing-models.md#flat-rate) and other [pricing models](https://docs.stripe.com/products-prices/pricing-models.md).
1. Add an internal **Price description** and [Lookup key](https://docs.stripe.com/products-prices/manage-prices.md#lookup-keys) to organize, query, and update specific prices in the future.
1. Click **Next**. Then click **Add product**.
After you create the product and the price, record the price ID so you can use it in subsequent steps. The pricing page displays the ID and it looks similar to this: `price_G0FvDp6vZvdwRZ`.
## Create a Checkout Session [Server-side]
Your customer must authorize you to use their bank account for future payments through Stripe Checkout. This allows you to accept PayTo payments. Add a checkout button to your website that calls a server-side endpoint to create a [Checkout Session](https://docs.stripe.com/api/checkout/sessions.md).
```html
Checkout
```
Create a Checkout Session in `subscription` mode to collect the required information. After creating the Checkout Session, redirect your customer to the [URL](https://docs.stripe.com/api/checkout/sessions/object.md#checkout_session_object-url) that the response returns.
Limit the amount on your mandates by setting `amount` in the `payment_method_options` as several banks [always reject mandates without an amount specified](https://docs.stripe.com/payments/payto.md#bank-limits).
```curl
curl https://api.stripe.com/v1/checkout/sessions \
-u "<>:" \
--data-urlencode "success_url=https://example.com/success" \
-d "line_items[0][price]={{RECURRING_PRICE_ID}}" \
-d "line_items[0][quantity]=1" \
-d "payment_method_types[0]=card" \
-d "payment_method_types[1]=payto" \
-d "payment_method_options[payto][mandate_options][amount]=1500" \
-d mode=subscription
```
## Test your integration
Test your PayTo integration with your test API keys by using the various test PayIDs and bank account details below. Each set of details results in a different scenario your integration might commonly face in live mode.
#### PayID
| PayID | Description |
| -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `{any_prefix}+succeed@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `succeeded` after an additional 5 seconds. The mandate enters an `active` state. |
| `{any_prefix}+decline@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and an `invalid_authorization` decline code. The mandate enters an `inactive` state. |
| `{any_prefix}+expire@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and a `generic_decline` decline code. The mandate enters an `inactive` state. |
| `{any_prefix}+insufficient_funds@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `requires_payment_method` after an additional 5 seconds. Stripe returns the `payment_method_provider_decline` error code and an `insufficient_funds` decline code. The mandate enters an `inactive` state. |
| `{any_prefix}+revoke@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds then to `succeeded` after a further 5 seconds. The mandate begins in an `active` state and transitions to `inactive` after 1 minute. |
| `{any_prefix}+agreement_type_not_supported@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code. The mandate enters an `inactive` state. |
#### Account + BSB numbers
| BSB number | Account number | Description |
| ---------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `000000` | `000123456` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `succeeded` after an additional 5 seconds. The mandate enters an `active` state. |
| `000000` | `333333335` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and an `invalid_authorization` decline code. The mandate enters an `inactive` state. |
| `000000` | `333333337` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and a `generic_decline` decline code. The mandate enters an `inactive` state. |
| `000000` | `222222227` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `requires_payment_method` after an additional 5 seconds. Stripe returns the `payment_method_provider_decline` error code and an `insufficient_funds` decline code. The mandate enters an `inactive` state. |
| `000000` | `444444447` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `succeeded` after an additional 5 seconds. The mandate begins in an `active` state and transitions to `inactive` after 1 minute. |
| `000000` | `666666667` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code. The mandate enters an `inactive` state. |
# Subscriptions API
> This is a Subscriptions API for when api-integration is subscription. View the full page at https://docs.stripe.com/billing/subscriptions/payto?api-integration=subscription.
Create and confirm a Subscription using two API calls. The [first API call](https://docs.stripe.com/billing/subscriptions/payto.md#pi-create-subscription) sends customer and product information to the [Subscriptions API](https://docs.stripe.com/api/subscriptions.md) to create a Subscription and PaymentIntent in one call. The response includes a PaymentIntent ID that you must use in a [Payment Intents API](https://docs.stripe.com/api/payment_intents.md) call to [confirm a payment](https://docs.stripe.com/billing/subscriptions/payto.md#pi-confirm-payment).
## Create a product and price [Dashboard]
[Products](https://docs.stripe.com/api/products.md) represent the item or service you’re selling. [Prices](https://docs.stripe.com/api/prices.md) define how much and how frequently you charge for a product. This includes how much the product costs, what currency you accept, and whether it’s a one-time or recurring charge. If you only have a few products and prices, create and manage them in the Dashboard.
This guide uses a stock photo service as an example and charges customers a 15 AUD monthly subscription. To model this:
1. Go to the [Products](https://dashboard.stripe.com/products?active=true) page and click **Create product**.
1. Enter a **Name** for the product. You can optionally add a **Description** and upload an image of the product.
1. Select a **Product tax code**. Learn more about [product tax codes](https://docs.stripe.com/tax/tax-codes.md).
1. Select **Recurring**. Then enter **15** for the price and select **AUD** as the currency.
1. Choose whether to **Include tax in price**. You can either use the default value from your [tax settings](https://dashboard.stripe.com/test/settings/tax) or set the value manually. In this example, select **Auto**.
1. Select **Monthly** for the **Billing period**.
1. Click **More pricing options**. Then select **Flat rate** as the pricing model for this example. Learn more about [flat rate](https://docs.stripe.com/products-prices/pricing-models.md#flat-rate) and other [pricing models](https://docs.stripe.com/products-prices/pricing-models.md).
1. Add an internal **Price description** and [Lookup key](https://docs.stripe.com/products-prices/manage-prices.md#lookup-keys) to organize, query, and update specific prices in the future.
1. Click **Next**. Then click **Add product**.
After you create the product and the price, record the price ID so you can use it in subsequent steps. The pricing page displays the ID and it looks similar to this: `price_G0FvDp6vZvdwRZ`.
## Create a subscription [Server-side]
Create a [subscription](https://docs.stripe.com/api/subscriptions.md) that has a price and a customer with the `incomplete` status by providing the [payment_behavior](https://docs.stripe.com/api/subscriptions/create.md#create_subscription-payment_behavior) parameter with a value of `default_incomplete`. Set the `payment_settings.save_default_payment_method=on_subscription` parameter to save a payment method when a subscription is activated.
Limit the amount on your mandates by setting `amount` in the `payment_method_options` as several banks [always reject mandates without an amount specified](https://docs.stripe.com/payments/payto.md#bank-limits).
```curl
curl https://api.stripe.com/v1/subscriptions \
-u "<>:" \
-d customer={{CUSTOMER_ID}} \
-d payment_behavior=default_incomplete \
-d "items[0][price]={{PRICE_ID}}" \
-d "payment_settings[save_default_payment_method]=on_subscription" \
-d "payment_settings[payment_method_options][payto][mandate_options][amount]=1500" \
-d "expand[0]=latest_invoice.payments" \
-d "expand[1]=latest_invoice.confirmation_secret"
```
The response includes the *subscription* (A Subscription represents the product details associated with the plan that your customer subscribes to. Allows you to charge the customer on a recurring basis)’s first [Invoice](https://docs.stripe.com/api/invoices.md). This contains the invoice’s payments, which includes a default PaymentIntent that Stripe generated for this invoice and the confirmation secret that you can use on the client side to securely complete the payment process instead of passing the entire PaymentIntent object. Return the `latest_invoice.confirmation_secret.client_secret` to the front end to complete payment. Get the PaymentIntent ID that you must use to confirm a payment from `latest_invoice.payments`.
## Confirm a payment [Server-side]
Confirm a payment with [PaymentIntents](https://docs.stripe.com/api/payment_intents.md) using the PaymentIntent ID from the Subscriptions response. And then add the PaymentIntent ID to the URL path and set the value of the `payment_method_types` parameter to `payto`:
```curl
curl https://api.stripe.com/v1/payment_intents/:id/confirm \
-u "<>:" \
-d "payment_method_data[type]=payto" \
--data-urlencode "return_url=https://www.stripe.com" \
-d "mandate_data[customer_acceptance][type]=online" \
-d "mandate_data[customer_acceptance][online][ip_address]=127.0.0.0" \
-d "mandate_data[customer_acceptance][online][user_agent]=device" \
-d "mandate_data[customer_acceptance][accepted_at]=1660000000"
```
The PaymentIntent response includes the status `requires_action`, which indicates that your users must authenticate with PayTo to complete the PaymentIntent. After a successful payment, the subscription becomes active and saves the payment method as the default payment method.
## Test your integration
Test your PayTo integration with your test API keys by using the various test PayIDs and bank account details below. Each set of details results in a different scenario your integration might commonly face in live mode.
#### PayID
| PayID | Description |
| -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `{any_prefix}+succeed@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `succeeded` after an additional 5 seconds. The mandate enters an `active` state. |
| `{any_prefix}+decline@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and an `invalid_authorization` decline code. The mandate enters an `inactive` state. |
| `{any_prefix}+expire@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and a `generic_decline` decline code. The mandate enters an `inactive` state. |
| `{any_prefix}+insufficient_funds@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `requires_payment_method` after an additional 5 seconds. Stripe returns the `payment_method_provider_decline` error code and an `insufficient_funds` decline code. The mandate enters an `inactive` state. |
| `{any_prefix}+revoke@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds then to `succeeded` after a further 5 seconds. The mandate begins in an `active` state and transitions to `inactive` after 1 minute. |
| `{any_prefix}+agreement_type_not_supported@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code. The mandate enters an `inactive` state. |
#### Account + BSB numbers
| BSB number | Account number | Description |
| ---------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `000000` | `000123456` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `succeeded` after an additional 5 seconds. The mandate enters an `active` state. |
| `000000` | `333333335` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and an `invalid_authorization` decline code. The mandate enters an `inactive` state. |
| `000000` | `333333337` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and a `generic_decline` decline code. The mandate enters an `inactive` state. |
| `000000` | `222222227` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `requires_payment_method` after an additional 5 seconds. Stripe returns the `payment_method_provider_decline` error code and an `insufficient_funds` decline code. The mandate enters an `inactive` state. |
| `000000` | `444444447` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `succeeded` after an additional 5 seconds. The mandate begins in an `active` state and transitions to `inactive` after 1 minute. |
| `000000` | `666666667` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code. The mandate enters an `inactive` state. |
# SetupIntents API
> This is a SetupIntents API for when api-integration is setupintents. View the full page at https://docs.stripe.com/billing/subscriptions/payto?api-integration=setupintents.
Create and confirm a subscription using two API calls. The [first API call](https://docs.stripe.com/billing/subscriptions/payto.md#create-setup-intent) uses the [Setup Intents API](https://docs.stripe.com/api/setup_intents.md) to set PayTo as a payment method. The [second API call](https://docs.stripe.com/billing/subscriptions/payto.md#create-subscription) sends customer, product, and payment method information to the [Subscriptions API](https://docs.stripe.com/api/subscriptions.md) to create a Subscription and confirm a payment in one call.
## Create a product and price [Dashboard]
[Products](https://docs.stripe.com/api/products.md) represent the item or service you’re selling. [Prices](https://docs.stripe.com/api/prices.md) define how much and how frequently you charge for a product. This includes how much the product costs, what currency you accept, and whether it’s a one-time or recurring charge. If you only have a few products and prices, create and manage them in the Dashboard.
This guide uses a stock photo service as an example and charges customers a 15 AUD monthly subscription. To model this:
1. Go to the [Products](https://dashboard.stripe.com/products?active=true) page and click **Create product**.
1. Enter a **Name** for the product. You can optionally add a **Description** and upload an image of the product.
1. Select a **Product tax code**. Learn more about [product tax codes](https://docs.stripe.com/tax/tax-codes.md).
1. Select **Recurring**. Then enter **15** for the price and select **AUD** as the currency.
1. Choose whether to **Include tax in price**. You can either use the default value from your [tax settings](https://dashboard.stripe.com/test/settings/tax) or set the value manually. In this example, select **Auto**.
1. Select **Monthly** for the **Billing period**.
1. Click **More pricing options**. Then select **Flat rate** as the pricing model for this example. Learn more about [flat rate](https://docs.stripe.com/products-prices/pricing-models.md#flat-rate) and other [pricing models](https://docs.stripe.com/products-prices/pricing-models.md).
1. Add an internal **Price description** and [Lookup key](https://docs.stripe.com/products-prices/manage-prices.md#lookup-keys) to organize, query, and update specific prices in the future.
1. Click **Next**. Then click **Add product**.
After you create the product and the price, record the price ID so you can use it in subsequent steps. The pricing page displays the ID and it looks similar to this: `price_G0FvDp6vZvdwRZ`.
## Create a SetupIntent [Server-side]
Create a [SetupIntent](https://docs.stripe.com/api/setup_intents.md) to save a customer’s payment method for future payments. The `SetupIntent` tracks the steps of this setup process.
Limit the amount on your mandates by setting `amount` in the `payment_method_options` as several banks [always reject mandates without an amount specified](https://docs.stripe.com/payments/payto.md#bank-limits).
```curl
curl https://api.stripe.com/v1/setup_intents \
-u "<>:" \
-d confirm=true \
--data-urlencode "return_url=https://www.stripe.com" \
-d usage=off_session \
-d customer=cus_ODQluYFNl44ODI \
-d "payment_method_data[type]=payto" \
-d "payment_method_types[]=payto" \
-d "payment_method_options[payto][mandate_options][amount]=1500" \
-d "mandate_data[customer_acceptance][type]=online" \
-d "mandate_data[customer_acceptance][online][ip_address]=127.0.0.0" \
-d "mandate_data[customer_acceptance][online][user_agent]=device"
```
The SetupIntent object contains a `client_secret`, which is a unique key that you must pass to Stripe.js on the client side to redirect your buyer to PayTo and authorize the mandate.
## Create a subscription [Server-side]
Create a subscription that has a price and a customer. Set the value of the `default_payment_method` parameter to the PaymentMethod ID from the SetupIntent response.
```curl
curl https://api.stripe.com/v1/subscriptions \
-u "<>:" \
-d customer={{CUSTOMER_ID}} \
-d "items[0][price]={{PRICE_ID}}" \
-d default_payment_method={{PAYMENT_METHOD_ID}} \
-d off_session=true
```
Creating subscriptions automatically charges customers because of the pre-set default payment method. After a successful payment, the status in the Stripe Dashboard changes to **Active**. The price that you previously set up determines the amount for future billings.
## Test your integration
Test your PayTo integration with your test API keys by using the various test PayIDs and bank account details below. Each set of details results in a different scenario your integration might commonly face in live mode.
#### PayID
| PayID | Description |
| -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `{any_prefix}+succeed@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `succeeded` after an additional 5 seconds. The mandate enters an `active` state. |
| `{any_prefix}+decline@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and an `invalid_authorization` decline code. The mandate enters an `inactive` state. |
| `{any_prefix}+expire@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and a `generic_decline` decline code. The mandate enters an `inactive` state. |
| `{any_prefix}+insufficient_funds@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `requires_payment_method` after an additional 5 seconds. Stripe returns the `payment_method_provider_decline` error code and an `insufficient_funds` decline code. The mandate enters an `inactive` state. |
| `{any_prefix}+revoke@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds then to `succeeded` after a further 5 seconds. The mandate begins in an `active` state and transitions to `inactive` after 1 minute. |
| `{any_prefix}+agreement_type_not_supported@{any_domain}` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code. The mandate enters an `inactive` state. |
#### Account + BSB numbers
| BSB number | Account number | Description |
| ---------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `000000` | `000123456` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `succeeded` after an additional 5 seconds. The mandate enters an `active` state. |
| `000000` | `333333335` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and an `invalid_authorization` decline code. The mandate enters an `inactive` state. |
| `000000` | `333333337` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code and a `generic_decline` decline code. The mandate enters an `inactive` state. |
| `000000` | `222222227` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `requires_payment_method` after an additional 5 seconds. Stripe returns the `payment_method_provider_decline` error code and an `insufficient_funds` decline code. The mandate enters an `inactive` state. |
| `000000` | `444444447` | The PaymentIntent status transitions from `requires_action` to `processing` after 10 seconds, then transitions to `succeeded` after an additional 5 seconds. The mandate begins in an `active` state and transitions to `inactive` after 1 minute. |
| `000000` | `666666667` | The PaymentIntent status transitions from `requires_action` to `requires_payment_method` after 10 seconds. Stripe returns the `payment_method_provider_decline` error code. The mandate enters an `inactive` state. |