HostedButton

buttonIdstringrequired

checkoutUrlstringrequired

createSubscription objectnullable

endDatestring<date>nullable

intervalCheckoutSubscriptionIntervalrequired

Possible values: [DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY]

intervalCountinteger<int32>nullable

Possible values: >= 1

maxCyclesinteger<int32>nullable

Possible values: >= 1

metadata objectnullable

property name*anynullable

planNamestringrequired

Possible values: non-empty

startDatestring<date>required

webhookUrlstringnullable

currencystringrequired

ISO 4217 currency of the payment link.

displayNamestringnullable

embedCodestringrequired

expiresAtstring<date-time>nullable

imageUrlstringnullable

lineItems object[]

Array [

namestringnullable

Description of a custom fixed-amount line; null for catalog lines.

priceIdstringnullable

Catalog price identifier; null for a custom fixed-amount line.

quantityinteger<int32>required

unitPriceinteger<int64>nullable

Unit price in minor units of the link's currency for a custom line; null for catalog lines.

]

openAmountboolean

statusPaymentLinkStatus

Possible values: [ACTIVE, PAUSED]

titlestringnullable

HostedButton
{
  "buttonId": "string",
  "checkoutUrl": "string",
  "createSubscription": {
    "endDate": "2024-07-29",
    "interval": "DAILY",
    "intervalCount": 0,
    "maxCycles": 0,
    "metadata": {},
    "planName": "string",
    "startDate": "2024-07-29",
    "webhookUrl": "string"
  },
  "currency": "string",
  "displayName": "string",
  "embedCode": "string",
  "expiresAt": "2024-07-29T15:51:28.071Z",
  "imageUrl": "string",
  "lineItems": [
    {
      "name": "string",
      "priceId": "string",
      "quantity": 0,
      "unitPrice": 0
    }
  ],
  "openAmount": true,
  "status": "ACTIVE",
  "title": "string"
}