FRfrisbii
signup

Signup a customer

post/v1/signup_page/signup_customer

Request

  • Base URL
    https://checkout-api.frisbii.com
  • URL
    https://checkout-api.frisbii.com/v1/signup_page/signup_customer
  • Auth
    none declared

Request body

emailstring

Customer email. Validated against RFC 822.

addressstring

Customer address

citystring

Customer city

countrystring

Customer country in ISO 3166-1 alpha-2

phonestring

Customer phone number

companystring

Customer company

couponsstring[]

Coupons

languagestring

Customer language

signup_page_handlestring required

Signup page handle. Max length 255 with allowable characters [a-zA-Z0-9_.-@].

product_handlestring required

Product handle. Max length 255 with allowable characters [a-zA-Z0-9_.-@].

account_idstring required

Account ID. Max length 255 with allowable characters [a-zA-Z0-9_.-@].

first_namestring

Customer first name

last_namestring

Customer last name

postal_codestring

Customer postal code

vat_numberstring

Customer VAT number

plan_quantityinteger

Plan quantity. This parameter allows customers to customize the number of subscriptions that can be purchased simultaneously. This parameter is taken into account only if the product's configuration allows quantity overwriting; otherwise, the quantity specified in the subscription plan is used.

subscription_startstring

Date and time on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss from which the subscription is eligible to schedule first invoice. If no time part is given start of day will be used. A start date in the past can be used, but no more than one period length in the past. A start date in the past can result in an instant invoice for a past billing period start. Default value is current date and time.

custom_fieldsobject

Key/value pairs for the custom fields of the given hosted page product

consent_acceptedboolean

Flag indicating whether the customer has accepted the consent definitions and the policies, if presented on the signup page.

Example request

{
  "email": "carl@leone.com",
  "address": "Grove Street 12",
  "city": "Los Santos",
  "country": "US",
  "phone": "555-66666",
  "company": "Frisbii Denmark A/S",
  "language": "en",
  "first_name": "Carl",
  "last_name": "Johnson",
  "postal_code": "4531",
  "vat_number": "US123456789",
  "plan_quantity": 1,
  "subscription_start": "2015-05-14T00:00:00"
}

Response

Successful operation

session_idstring

Changes

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