Start a new checkout session for renewing a subscription.

POST

/cms/customer/subscription/{subscription_id}/checkout

• The API server for the WhiteBeard News Suite
• Local development server for the WhiteBeard News Suite
• Local worker for the WhiteBeard News Suite

Use this when the initial renewal attempt failed and you need to collect payment details again. This will create a new unpaid payment and return the checkout session details from the payment provider.

Authorizations

• ApiKeyAuth
• CustomerAuth
• DeprecatedCustomerAuth

Parameters

Path Parameters

subscription_id

required

integer

Subscription ID

Responses

200

Renewal successful

object

success

Indicates if request for renewal was successful. If not, only the subscription details are returned.

boolean

response

Payment provider response

object

payment

Payment

API representation of a payment

object

id

Payment ID

price

Total price

status

Payment status

string

responseMessage

Response message

string

lastUpdate

Last update timestamp

string format: date-time

timestamp

Payment timestamp

string format: date-time

userId

User ID

paymentMethod

Payment method

string

cart

Cart items

Array<object>

object

item

Product Item

API representation of an ecommerce product item

object

id

Item ID

description

Description

string

productId

Product ID

product

Product name

string

price

Price

currency

Currency

string

available

Available

item_order

Item order

shippable

Shippable

weight

Weight

installments

Installments

oncePerUser

Once per user

isUpgrade

Is upgrade

upgradeType

Upgrade type

string

upgradeFrom

Upgrade from

string

upgradeExcludeItems

Upgrade exclude items

string

upgradePriceWeb

Upgrade price web

upgradePriceMobile

Upgrade price mobile

settings

Settings

object

hasImage

Has image

additional_label_1

Additional label 1

string

additional_label_2

Additional label 2

string

additional_label_3

Additional label 3

string

diameter

Diameter

length

Length

depth

Depth

width

Width

recurrent

Recurrent

recurrentPrice

Recurrent price

recurrentStart

Recurrent start

string

recurrentSchedule

Recurrent schedule

string

sku

SKU

string

prices

Prices

object

stock_enabled

Stock enabled

stock_available

Stock available

packageQuantity

Package quantity

relatedItems

Related items

Array<object>

object

images

Images

Array<string>

files

Files

Array<string>

product_details

Product details. Deprecated to avoid circular references. Use productId instead.

object

translations

Translations

Example

{
  "en": {
    "name": "Name",
    "subtitle": "Subtitle"
  },
  "fr": {
    "name": "Nom",
    "subtitle": "Sous-titre"
  }
}

actionData

Action data to be executed when a product item is bought

Array<object>

object

function

string

Example

registerSubscription

param

string

Example

365

group

string

Example

subscription

Example

[
  {
    "function": "registerSubscription",
    "param": "365",
    "group": "subscription"
  }
]

actionDataRenew

Action data to be executed when a product item is bought as a renewal

Array<object>

object

function

string

Example

registerSubscription

param

string

Example

365

group

string

Example

subscription

Example

[
  {
    "function": "registerSubscription",
    "param": "365",
    "group": "subscription"
  }
]

quantity

integer

price

number format: float

price_matrix

Price matrix

object

subtotal

Subtotal amount

number

shipping

Shipping amount

number

tax

Tax amount

number

discount

Discount amount

number

total

Total amount

number

shippingStatus

Shipping status

string

authorization

Authorization

string

address

Address

object

shipping_address

Shipping address

object

shipping_price

Shipping price

tax_price

Tax price

subscription

Subscription

API representation of a customer subscription

object

id

Subscription ID

activationDate

Activation date

string format: date-time

deactivationDate

Deactivation date

string format: date-time

userId

User ID

status

Status

integer

purchased_item

One of:

Product Item

Product Item

API representation of an ecommerce product item

object

id

Item ID

description

Description

string

productId

Product ID

product

Product name

string

price

Price

currency

Currency

string

available

Available

item_order

Item order

shippable

Shippable

weight

Weight

installments

Installments

oncePerUser

Once per user

isUpgrade

Is upgrade

upgradeType

Upgrade type

string

upgradeFrom

Upgrade from

string

upgradeExcludeItems

Upgrade exclude items

string

upgradePriceWeb

Upgrade price web

upgradePriceMobile

Upgrade price mobile

settings

Settings

object

hasImage

Has image

additional_label_1

Additional label 1

string

additional_label_2

Additional label 2

string

additional_label_3

Additional label 3

string

diameter

Diameter

length

Length

depth

Depth

width

Width

recurrent

Recurrent

recurrentPrice

Recurrent price

recurrentStart

Recurrent start

string

recurrentSchedule

Recurrent schedule

string

sku

SKU

string

prices

Prices

object

stock_enabled

Stock enabled

stock_available

Stock available

packageQuantity

Package quantity

relatedItems

Related items

Array<object>

object

images

Images

Array<string>

files

Files

Array<string>

product_details

Product details. Deprecated to avoid circular references. Use productId instead.

object

translations

Translations

Example

{
  "en": {
    "name": "Name",
    "subtitle": "Subtitle"
  },
  "fr": {
    "name": "Nom",
    "subtitle": "Sous-titre"
  }
}

actionData

Action data to be executed when a product item is bought

Array<object>

object

function

string

Example

registerSubscription

param

string

Example

365

group

string

Example

subscription

Example

[
  {
    "function": "registerSubscription",
    "param": "365",
    "group": "subscription"
  }
]

actionDataRenew

Action data to be executed when a product item is bought as a renewal

Array<object>

object

function

string

Example

registerSubscription

param

string

Example

365

group

string

Example

subscription

Example

[
  {
    "function": "registerSubscription",
    "param": "365",
    "group": "subscription"
  }
]

nextRenewal

Next renewal date

string format: date-time

lastFailedOrder

Last failed order ID

attempts

Attempts

integer

referenceOrderId

Reference order ID

group

Group code

string

group_name

Group name

string

paymentMethod

Payment method

string

cancellationRequestDate

Cancellation request date

string format: date-time

nullable

cancellationReason

Cancellation reason

string

nullable

cancellationReasonCustom

Cancellation reason (custom user text)

string

nullable

currency

Currency

string

400

Bad Request

401

Unauthorized

404

Subscription not found