Update a plan

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/subscriptions/plan/update \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "planId": "<string>",
  "subMerchantId": "<string>",
  "name": "Black friday test plan",
  "description": "Black friday test plan description",
  "schedules": [
    {
      "order": 1,
      "label": "Silver",
      "invoiceDescription": "Invoice for \"Silver\" schedule.",
      "cyclesQty": 3,
      "frequency": "monthly",
      "executionDays": [
        10
      ],
      "pricingModel": {
        "type": "flat",
        "free": {
          "daysQty": 10
        },
        "flat": {
          "price": 100
        },
        "flatTiered": {
          "tiers": [
            {
              "name": "Basic",
              "description": "<string>",
              "price": 100,
              "featuresSettings": {
                "label": "<string>",
                "features": [
                  {
                    "icon": "<string>",
                    "name": "<string>",
                    "description": "<string>",
                    "link": "<string>"
                  }
                ]
              }
            }
          ]
        },
        "perModule": {
          "modules": [
            {
              "name": "Basic",
              "description": "<string>",
              "price": 100,
              "featuresSettings": {
                "label": "<string>",
                "features": [
                  {
                    "icon": "<string>",
                    "name": "<string>",
                    "description": "<string>",
                    "link": "<string>"
                  }
                ]
              }
            }
          ]
        },
        "perUsageQuantity": {
          "unitPrice": 10
        },
        "perUsageVolume": {
          "steps": [
            {
              "startQty": 1,
              "endQty": 9,
              "unitPrice": 15
            }
          ]
        },
        "perUsageTiered": {
          "tiers": [
            {
              "name": "Basic",
              "description": "<string>",
              "price": 100,
              "featuresSettings": {
                "label": "<string>",
                "features": [
                  {
                    "icon": "<string>",
                    "name": "<string>",
                    "description": "<string>",
                    "link": "<string>"
                  }
                ]
              }
            }
          ]
        }
      },
      "enabled": true,
      "featuresEnabled": false
    }
  ]
}
'

import requests

url = "https://sandbox-platform.jupico.com/v1/subscriptions/plan/update"

payload = {
    "planId": "<string>",
    "subMerchantId": "<string>",
    "name": "Black friday test plan",
    "description": "Black friday test plan description",
    "schedules": [
        {
            "order": 1,
            "label": "Silver",
            "invoiceDescription": "Invoice for \"Silver\" schedule.",
            "cyclesQty": 3,
            "frequency": "monthly",
            "executionDays": [10],
            "pricingModel": {
                "type": "flat",
                "free": { "daysQty": 10 },
                "flat": { "price": 100 },
                "flatTiered": { "tiers": [
                        {
                            "name": "Basic",
                            "description": "<string>",
                            "price": 100,
                            "featuresSettings": {
                                "label": "<string>",
                                "features": [
                                    {
                                        "icon": "<string>",
                                        "name": "<string>",
                                        "description": "<string>",
                                        "link": "<string>"
                                    }
                                ]
                            }
                        }
                    ] },
                "perModule": { "modules": [
                        {
                            "name": "Basic",
                            "description": "<string>",
                            "price": 100,
                            "featuresSettings": {
                                "label": "<string>",
                                "features": [
                                    {
                                        "icon": "<string>",
                                        "name": "<string>",
                                        "description": "<string>",
                                        "link": "<string>"
                                    }
                                ]
                            }
                        }
                    ] },
                "perUsageQuantity": { "unitPrice": 10 },
                "perUsageVolume": { "steps": [
                        {
                            "startQty": 1,
                            "endQty": 9,
                            "unitPrice": 15
                        }
                    ] },
                "perUsageTiered": { "tiers": [
                        {
                            "name": "Basic",
                            "description": "<string>",
                            "price": 100,
                            "featuresSettings": {
                                "label": "<string>",
                                "features": [
                                    {
                                        "icon": "<string>",
                                        "name": "<string>",
                                        "description": "<string>",
                                        "link": "<string>"
                                    }
                                ]
                            }
                        }
                    ] }
            },
            "enabled": True,
            "featuresEnabled": False
        }
    ]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    planId: '<string>',
    subMerchantId: '<string>',
    name: 'Black friday test plan',
    description: 'Black friday test plan description',
    schedules: [
      {
        order: 1,
        label: 'Silver',
        invoiceDescription: 'Invoice for "Silver" schedule.',
        cyclesQty: 3,
        frequency: 'monthly',
        executionDays: [10],
        pricingModel: {
          type: 'flat',
          free: {daysQty: 10},
          flat: {price: 100},
          flatTiered: {
            tiers: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          },
          perModule: {
            modules: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          },
          perUsageQuantity: {unitPrice: 10},
          perUsageVolume: {steps: [{startQty: 1, endQty: 9, unitPrice: 15}]},
          perUsageTiered: {
            tiers: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          }
        },
        enabled: true,
        featuresEnabled: false
      }
    ]
  })
};

fetch('https://sandbox-platform.jupico.com/v1/subscriptions/plan/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/subscriptions/plan/update';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    planId: '<string>',
    subMerchantId: '<string>',
    name: 'Black friday test plan',
    description: 'Black friday test plan description',
    schedules: [
      {
        order: 1,
        label: 'Silver',
        invoiceDescription: 'Invoice for "Silver" schedule.',
        cyclesQty: 3,
        frequency: 'monthly',
        executionDays: [10],
        pricingModel: {
          type: 'flat',
          free: {daysQty: 10},
          flat: {price: 100},
          flatTiered: {
            tiers: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          },
          perModule: {
            modules: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          },
          perUsageQuantity: {unitPrice: 10},
          perUsageVolume: {steps: [{startQty: 1, endQty: 9, unitPrice: 15}]},
          perUsageTiered: {
            tiers: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          }
        },
        enabled: true,
        featuresEnabled: false
      }
    ]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

POST

https://sandbox-platform.jupico.com

subscriptions

plan

update

Update a plan

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/subscriptions/plan/update \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "planId": "<string>",
  "subMerchantId": "<string>",
  "name": "Black friday test plan",
  "description": "Black friday test plan description",
  "schedules": [
    {
      "order": 1,
      "label": "Silver",
      "invoiceDescription": "Invoice for \"Silver\" schedule.",
      "cyclesQty": 3,
      "frequency": "monthly",
      "executionDays": [
        10
      ],
      "pricingModel": {
        "type": "flat",
        "free": {
          "daysQty": 10
        },
        "flat": {
          "price": 100
        },
        "flatTiered": {
          "tiers": [
            {
              "name": "Basic",
              "description": "<string>",
              "price": 100,
              "featuresSettings": {
                "label": "<string>",
                "features": [
                  {
                    "icon": "<string>",
                    "name": "<string>",
                    "description": "<string>",
                    "link": "<string>"
                  }
                ]
              }
            }
          ]
        },
        "perModule": {
          "modules": [
            {
              "name": "Basic",
              "description": "<string>",
              "price": 100,
              "featuresSettings": {
                "label": "<string>",
                "features": [
                  {
                    "icon": "<string>",
                    "name": "<string>",
                    "description": "<string>",
                    "link": "<string>"
                  }
                ]
              }
            }
          ]
        },
        "perUsageQuantity": {
          "unitPrice": 10
        },
        "perUsageVolume": {
          "steps": [
            {
              "startQty": 1,
              "endQty": 9,
              "unitPrice": 15
            }
          ]
        },
        "perUsageTiered": {
          "tiers": [
            {
              "name": "Basic",
              "description": "<string>",
              "price": 100,
              "featuresSettings": {
                "label": "<string>",
                "features": [
                  {
                    "icon": "<string>",
                    "name": "<string>",
                    "description": "<string>",
                    "link": "<string>"
                  }
                ]
              }
            }
          ]
        }
      },
      "enabled": true,
      "featuresEnabled": false
    }
  ]
}
'

import requests

url = "https://sandbox-platform.jupico.com/v1/subscriptions/plan/update"

payload = {
    "planId": "<string>",
    "subMerchantId": "<string>",
    "name": "Black friday test plan",
    "description": "Black friday test plan description",
    "schedules": [
        {
            "order": 1,
            "label": "Silver",
            "invoiceDescription": "Invoice for \"Silver\" schedule.",
            "cyclesQty": 3,
            "frequency": "monthly",
            "executionDays": [10],
            "pricingModel": {
                "type": "flat",
                "free": { "daysQty": 10 },
                "flat": { "price": 100 },
                "flatTiered": { "tiers": [
                        {
                            "name": "Basic",
                            "description": "<string>",
                            "price": 100,
                            "featuresSettings": {
                                "label": "<string>",
                                "features": [
                                    {
                                        "icon": "<string>",
                                        "name": "<string>",
                                        "description": "<string>",
                                        "link": "<string>"
                                    }
                                ]
                            }
                        }
                    ] },
                "perModule": { "modules": [
                        {
                            "name": "Basic",
                            "description": "<string>",
                            "price": 100,
                            "featuresSettings": {
                                "label": "<string>",
                                "features": [
                                    {
                                        "icon": "<string>",
                                        "name": "<string>",
                                        "description": "<string>",
                                        "link": "<string>"
                                    }
                                ]
                            }
                        }
                    ] },
                "perUsageQuantity": { "unitPrice": 10 },
                "perUsageVolume": { "steps": [
                        {
                            "startQty": 1,
                            "endQty": 9,
                            "unitPrice": 15
                        }
                    ] },
                "perUsageTiered": { "tiers": [
                        {
                            "name": "Basic",
                            "description": "<string>",
                            "price": 100,
                            "featuresSettings": {
                                "label": "<string>",
                                "features": [
                                    {
                                        "icon": "<string>",
                                        "name": "<string>",
                                        "description": "<string>",
                                        "link": "<string>"
                                    }
                                ]
                            }
                        }
                    ] }
            },
            "enabled": True,
            "featuresEnabled": False
        }
    ]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    planId: '<string>',
    subMerchantId: '<string>',
    name: 'Black friday test plan',
    description: 'Black friday test plan description',
    schedules: [
      {
        order: 1,
        label: 'Silver',
        invoiceDescription: 'Invoice for "Silver" schedule.',
        cyclesQty: 3,
        frequency: 'monthly',
        executionDays: [10],
        pricingModel: {
          type: 'flat',
          free: {daysQty: 10},
          flat: {price: 100},
          flatTiered: {
            tiers: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          },
          perModule: {
            modules: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          },
          perUsageQuantity: {unitPrice: 10},
          perUsageVolume: {steps: [{startQty: 1, endQty: 9, unitPrice: 15}]},
          perUsageTiered: {
            tiers: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          }
        },
        enabled: true,
        featuresEnabled: false
      }
    ]
  })
};

fetch('https://sandbox-platform.jupico.com/v1/subscriptions/plan/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/subscriptions/plan/update';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    planId: '<string>',
    subMerchantId: '<string>',
    name: 'Black friday test plan',
    description: 'Black friday test plan description',
    schedules: [
      {
        order: 1,
        label: 'Silver',
        invoiceDescription: 'Invoice for "Silver" schedule.',
        cyclesQty: 3,
        frequency: 'monthly',
        executionDays: [10],
        pricingModel: {
          type: 'flat',
          free: {daysQty: 10},
          flat: {price: 100},
          flatTiered: {
            tiers: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          },
          perModule: {
            modules: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          },
          perUsageQuantity: {unitPrice: 10},
          perUsageVolume: {steps: [{startQty: 1, endQty: 9, unitPrice: 15}]},
          perUsageTiered: {
            tiers: [
              {
                name: 'Basic',
                description: '<string>',
                price: 100,
                featuresSettings: {
                  label: '<string>',
                  features: [
                    {icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
                  ]
                }
              }
            ]
          }
        },
        enabled: true,
        featuresEnabled: false
      }
    ]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

planId

string

required

The planId that ident the subscription plan

subMerchantId

string

required

The subMerchantId associated with the plan.

name

string

required

Plan's name.

Example:

"Black friday test plan"

description

string

required

Plan's description.

Example:

"Black friday test plan description"

schedules

object[]

required

Array containing plan's schedules.

Hide child attributes

schedules.order

number

Schedule order.

Example:

1

schedules.label

string

Schedule's label

Example:

"Silver"

schedules.invoiceDescription

string

Schedule's description to make invoice.

Example:

"Invoice for \"Silver\" schedule."

schedules.cyclesQty

number

Number of cycles of schedule

Example:

3

schedules.frequency

enum<string>

Billing frequency

Available options:

one-time,

daily,

weekly,

every-28-days,

biweekly,

monthly,

yearly

Example:

"monthly"

schedules.executionDays

number[]

Days on which scheduled charges execute.

Array of billing numbers day[0-32] for monthly, 0 at period start(month's 1st), 32 at period end(month's last day)

schedules.pricingModel

object

Pricing models params.

Hide child attributes

schedules.pricingModel.type

string

Pricing model type, one of ["free", "flat", "flatTiered", "perModule", "perUsageQuantity", "perUsageVolume", "perUsageTiered"]. Depending of this value you must provide corresponding next atribute.

Example:

"flat"

schedules.pricingModel.free

object

Free trial configuration.

Hide child attributes

schedules.pricingModel.free.daysQty

number

Free days quantity

Example:

10

schedules.pricingModel.flat

object

Flat pricing: a fixed price per billing cycle.

Hide child attributes

schedules.pricingModel.flat.price

number

Price charged each billing cycle.

Example:

100

schedules.pricingModel.flatTiered

object

Flat pricing with selectable tiers.

Hide child attributes

schedules.pricingModel.flatTiered.tiers

object[]

Available tiers for this schedule.

Hide child attributes

schedules.pricingModel.flatTiered.tiers.name

string

Display name of the tier.

Example:

"Basic"

schedules.pricingModel.flatTiered.tiers.description

string

Description of the tier shown to the customer.

schedules.pricingModel.flatTiered.tiers.price

number

Price of the tier per billing cycle.

Example:

100

schedules.pricingModel.flatTiered.tiers.featuresSettings

object

Display settings for the tier's feature list.

Hide child attributes

schedules.pricingModel.flatTiered.tiers.featuresSettings.label

string

Heading displayed above the feature list.

schedules.pricingModel.flatTiered.tiers.featuresSettings.features

object[]

Feature list displayed for this tier.

Hide child attributes

schedules.pricingModel.flatTiered.tiers.featuresSettings.features.icon

string

Icon displayed next to the feature.

schedules.pricingModel.flatTiered.tiers.featuresSettings.features.name

string

Display name.

schedules.pricingModel.flatTiered.tiers.featuresSettings.features.description

string

Free-text description.

schedules.pricingModel.flatTiered.tiers.featuresSettings.features.link

string

URL the feature links to.

schedules.pricingModel.perModule

object

Per-module pricing: the customer subscribes to individual modules.

Hide child attributes

schedules.pricingModel.perModule.modules

object[]

Modules available for subscription.

Hide child attributes

schedules.pricingModel.perModule.modules.name

string

Display name.

Example:

"Basic"

schedules.pricingModel.perModule.modules.description

string

Free-text description.

schedules.pricingModel.perModule.modules.price

number

Price per billing cycle.

Example:

100

schedules.pricingModel.perModule.modules.featuresSettings

object

Display settings for the feature list.

Hide child attributes

schedules.pricingModel.perModule.modules.featuresSettings.label

string

Heading displayed above the feature list.

schedules.pricingModel.perModule.modules.featuresSettings.features

object[]

Feature list displayed for this tier.

Hide child attributes

schedules.pricingModel.perModule.modules.featuresSettings.features.icon

string

Icon displayed next to the feature.

schedules.pricingModel.perModule.modules.featuresSettings.features.name

string

Display name.

schedules.pricingModel.perModule.modules.featuresSettings.features.description

string

Free-text description.

schedules.pricingModel.perModule.modules.featuresSettings.features.link

string

URL the feature links to.

schedules.pricingModel.perUsageQuantity

object

Usage-based pricing with a single per-unit price.

Hide child attributes

schedules.pricingModel.perUsageQuantity.unitPrice

number

Price per unit of usage.

Example:

10

schedules.pricingModel.perUsageVolume

object

Usage-based pricing where the unit price depends on total volume.

Hide child attributes

schedules.pricingModel.perUsageVolume.steps

object[]

Volume pricing steps.

Hide child attributes

schedules.pricingModel.perUsageVolume.steps.startQty

number

First unit quantity this step applies to.

Example:

1

schedules.pricingModel.perUsageVolume.steps.endQty

number

Last unit quantity this step applies to.

Example:

9

schedules.pricingModel.perUsageVolume.steps.unitPrice

number

Price per unit within this volume step.

Example:

15

schedules.pricingModel.perUsageTiered

object

Usage-based pricing with tiered rates per volume step.

Hide child attributes

schedules.pricingModel.perUsageTiered.tiers

object[]

Available tiers for this schedule.

Hide child attributes

schedules.pricingModel.perUsageTiered.tiers.name

string

Display name of the tier.

Example:

"Basic"

schedules.pricingModel.perUsageTiered.tiers.description

string

Description of the tier shown to the customer.

schedules.pricingModel.perUsageTiered.tiers.price

number

Price of the tier per billing cycle.

Example:

100

schedules.pricingModel.perUsageTiered.tiers.featuresSettings

object

Display settings for the tier's feature list.

Hide child attributes

schedules.pricingModel.perUsageTiered.tiers.featuresSettings.label

string

Heading displayed above the feature list.

schedules.pricingModel.perUsageTiered.tiers.featuresSettings.features

object[]

Feature list displayed for this tier.

Hide child attributes

schedules.pricingModel.perUsageTiered.tiers.featuresSettings.features.icon

string

Icon displayed next to the feature.

schedules.pricingModel.perUsageTiered.tiers.featuresSettings.features.name

string

Display name.

schedules.pricingModel.perUsageTiered.tiers.featuresSettings.features.description

string

Free-text description.

schedules.pricingModel.perUsageTiered.tiers.featuresSettings.features.link

string

URL the feature links to.

schedules.enabled

boolean

Whether this setting is enabled.

Example:

true

schedules.featuresEnabled

boolean

Whether tier features are enabled for this schedule.

Example:

false

title

string

Plan's title.

Example:

""

subTitle

string

Plan's sub title.

Example:

""

hostedSession

object

Object to edit configuration of created hosted session.

Hide child attributes

hostedSession.enabled

boolean

Only required field, setting enabled = true, we create a session with default values. In case you want customization, append below data.

Example:

true

hostedSession.paymentMethods

object

Payment methods offered on the hosted page.

Hide child attributes

hostedSession.paymentMethods.defaultMethod

string

Default payment method one of ["creditCard","eCheck", "applePay","googlePay"]

Example:

"creditCard"

hostedSession.paymentMethods.creditCard

object

Credit card acceptance settings for the hosted page.

Hide child attributes

hostedSession.paymentMethods.creditCard.enabled

boolean

Whether this setting is enabled.

Example:

true

hostedSession.paymentMethods.eCheck

object

eCheck (ACH) acceptance settings for the hosted page.

Hide child attributes

hostedSession.paymentMethods.eCheck.enabled

boolean

Whether this setting is enabled.

Example:

false

hostedSession.paymentMethods.applePay

object

Apple Pay acceptance settings for the hosted page.

Hide child attributes

hostedSession.paymentMethods.applePay.enabled

boolean

Whether this setting is enabled.

Example:

false

hostedSession.paymentMethods.googlePay

object

Google Pay acceptance settings for the hosted page.

Hide child attributes

hostedSession.paymentMethods.googlePay.enabled

boolean

Whether this setting is enabled.

Example:

false

hostedSession.flow

object

Navigation behavior of the hosted page.

Hide child attributes

hostedSession.flow.type

string

Default payment method one of ["standalone","redirect"]

Example:

"redirect"

hostedSession.flow.redirect

object

URLs the customer is redirected to during the flow.

Hide child attributes

hostedSession.flow.redirect.successUrl

string

URL the customer is redirected to after successful payment.

Example:

"https://yoursite.com/successUrl"

hostedSession.flow.redirect.cancelUrl

string

URL the customer is redirected to if they cancel.

Example:

"https://yoursite.com/cancelUrl"

hostedSession.flow.redirect.backUrl

string

URL the customer is redirected to when they navigate back.

Example:

"https://yoursite.com/backUrl"

hostedSession.functions

object

Hosted session functions

Hide child attributes

hostedSession.functions.collectBillingAddress

object

Collect the customer's billing address during checkout.

Hide child attributes

hostedSession.functions.collectBillingAddress.enabled

boolean

Whether this setting is enabled.

Example:

true

hostedSession.functions.collectShippingAddress

object

Collect the customer's shipping address during checkout.

Hide child attributes

hostedSession.functions.collectShippingAddress.enabled

boolean

Whether this setting is enabled.

Example:

false

hostedSession.functions.collectPhoneNumber

object

Collect the customer's phone number during checkout.

Hide child attributes

hostedSession.functions.collectPhoneNumber.enabled

boolean

Whether this setting is enabled.

Example:

true

hostedSession.functions.callToAction

object

Customization of the pay button.

Hide child attributes

hostedSession.functions.callToAction.enabled

boolean

Whether this setting is enabled.

Example:

true

hostedSession.functions.callToAction.label

string

Custom button label

Example:

"Pay"

hostedSession.functions.callToAction.note

string

Custom button label

Example:

"Note desc."

hostedSession.functions.notes

object

Free-text notes displayed on the hosted page.

Hide child attributes

hostedSession.functions.notes.enabled

boolean

Whether this setting is enabled.

Example:

false

hostedSession.functions.collectEmail

object

Collect the customer's email address during checkout.

Hide child attributes

hostedSession.functions.collectEmail.enabled

boolean

Whether this setting is enabled.

Example:

false

hostedSession.functions.collectEmail.updateCustomer

boolean

When true, the collected value is saved to the customer record.

Example:

false

hostedSession.constraints

object

Limits applied to the hosted session.

Hide child attributes

hostedSession.constraints.timeLimit

number

Number of minutes to keep session active

Example:

30

hostedSession.usage

object

How many times the hosted session link can be used.

Hide child attributes

hostedSession.usage.type

string

Usage type of hosted session. Posible values ["single_use","multi_use"]

Example:

"multi_use"

hostedSession.usage.quantity

string

In case of usage type "multi_use", this attribute update the hosted session payments/subscriptions limit.

Example:

5

Response

Plan successfully created.

API Overview

API Reference

Resources

Update a plan

Authorizations

Body

Response