admin-signup

Update a subscription product for signup pages

put/v1/admin/signup_page/product/{handle}

Request

  • Base URL
    https://checkout-api.frisbii.com
  • URL
    https://checkout-api.frisbii.com/v1/admin/signup_page/product/{handle}
  • Auth
    HTTP basic

Path parameters

handlestring required

Subscription product handle

Request body

iconstring

The Subscription product icon follows the scheme: <iconType> <iconName>. The icon type can be either "solid", "regular" or "brand" and the icon name can be anything from FontAwesome library. Example: solid bolt

namestring

Subscription product name

badgestring

Signup subscription product badge. Examples: 'POPULAR', 'NEW'

descriptionstring

Signup subscription product description

benefitsstring[]

A list of benefits for a subscription product

is_highlightedboolean

A flag for highlighting the visuals of a product

plan_handlestring required

Subscription plan

accept_urlstring

Accept url. May be different from the page's accept url.

cancel_urlstring

Cancel url. May be different from the page's cancel url.

custom_fields_section_titlestring

Custom fields section title

Example request

{
  "configuration": {
    "amount": 20000,
    "quantity": 3,
    "additional_costs": [
      {
        "ordertext": "Yoga mat",
        "quantity": 1,
        "amount": 10000,
        "vat": 0.25,
        "tax_policy": "ts_12345"
      }
    ],
    "grace_duration": 172800,
    "no_trial": true,
    "no_setup_fee": true
  }
}

Response

Successful operation

handlestring required

Signup subscription product handle

iconstring

The Subscription product icon follows the scheme: <iconType> <iconName>. The icon type can be either "solid", "regular" or "brand" and the icon name can be anything from FontAwesome library

namestring

Subscription product name

badgestring

Signup subscription product badge. Examples: 'POPULAR', 'NEW'

descriptionstring

Signup subscription product description

benefitsstring[]

A list of benefits for a subscription product

is_highlightedboolean

A flag for highlighting the visuals of a product

plan_handlestring required

Subscription plan handle

accept_urlstring

Accept url. May be different from the page's accept url.

cancel_urlstring

Cancel url. May be different from the page's cancel url.

custom_fields_section_titlestring

Custom fields section title

Changes

No recorded changes to this operation across all 1 revision of this API.