UpdateHostedButtonRequest

clearCreateSubscriptionboolean

clearExpiresAtboolean

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

descriptionstringnullable

displayNamestringnullable

Possible values: <= 255 characters

expiresAtstring<date-time>nullable

imageUrlstringnullable

lineItems object[]nullable

Array [

namestringnullable

Merchant-entered description for a custom fixed-amount line without priceId (max 255 characters).

priceIdstringnullable

Catalog price identifier. Required for catalog lines; must not be sent with name or unitPrice.

quantityinteger<int32>

Possible values: >= 1

unitPriceinteger<int64>nullable

Fixed unit price in minor units of the link's currency for a custom line without priceId. Must not be sent with priceId; a custom line has quantity 1 and cannot be combined with catalog lines, openAmount, or createSubscription.

]

locationIdstringnullable

merchantIdstringnullable

openAmountbooleannullable

statusPaymentLinkStatusnullable

Possible values: [ACTIVE, PAUSED]

titlestringnullable

UpdateHostedButtonRequest
{
  "clearCreateSubscription": true,
  "clearExpiresAt": true,
  "createSubscription": {
    "endDate": "2024-07-29",
    "interval": "DAILY",
    "intervalCount": 0,
    "maxCycles": 0,
    "metadata": {},
    "planName": "string",
    "startDate": "2024-07-29",
    "webhookUrl": "string"
  },
  "description": "string",
  "displayName": "string",
  "expiresAt": "2024-07-29T15:51:28.071Z",
  "imageUrl": "string",
  "lineItems": [
    {
      "name": "string",
      "priceId": "string",
      "quantity": 0,
      "unitPrice": 0
    }
  ],
  "locationId": "string",
  "merchantId": "string",
  "openAmount": true,
  "status": "ACTIVE",
  "title": "string"
}