Skip to content
Start here

Profiles

Get Billing Profile
GET/accounts/{account_id}/billing/profile
Create Billing Profile
POST/accounts/{account_id}/billing/profile
Update Billing Profile
PUT/accounts/{account_id}/billing/profile
Delete Billing Profile
DELETE/accounts/{account_id}/billing/profile
Update Billing Email
PATCH/accounts/{account_id}/billing/profile
ModelsExpand Collapse
ProfileGetResponse object { id, account_type, address, 35 more }
id: optional string

Billing item identifier tag.

maxLength32
account_type: optional string
address: optional string
address2: optional string
balance: optional string
card_expiry_month: optional number
card_expiry_year: optional number
card_number: optional string
city: optional string
company: optional string
country: optional string
created_on: optional string
formatdate-time
device_data: optional string
edited_on: optional string
formatdate-time
enterprise_billing_email: optional string
enterprise_primary_email: optional string
first_name: optional string
is_partner: optional boolean
last_name: optional string
next_bill_date: optional string
formatdate-time
payment_address: optional string
payment_address2: optional string
payment_city: optional string
payment_country: optional string
payment_email: optional string
payment_first_name: optional string
payment_gateway: optional string
payment_last_name: optional string
payment_nonce: optional string
payment_state: optional string
payment_zipcode: optional string
primary_email: optional string
state: optional string
tax_id_type: optional string
telephone: optional string
validation_code: optional string
vat: optional string
zipcode: optional string
ProfileCreateResponse object { id, account_type, address, 35 more }
id: optional string

Billing item identifier tag.

maxLength32
account_type: optional string
address: optional string
address2: optional string
balance: optional string
card_expiry_month: optional number
card_expiry_year: optional number
card_number: optional string
city: optional string
company: optional string
country: optional string
created_on: optional string
formatdate-time
device_data: optional string
edited_on: optional string
formatdate-time
enterprise_billing_email: optional string
enterprise_primary_email: optional string
first_name: optional string
is_partner: optional boolean
last_name: optional string
next_bill_date: optional string
formatdate-time
payment_address: optional string
payment_address2: optional string
payment_city: optional string
payment_country: optional string
payment_email: optional string
payment_first_name: optional string
payment_gateway: optional string
payment_last_name: optional string
payment_nonce: optional string
payment_state: optional string
payment_zipcode: optional string
primary_email: optional string
state: optional string
tax_id_type: optional string
telephone: optional string
validation_code: optional string
vat: optional string
zipcode: optional string
ProfileUpdateResponse object { id, account_type, address, 35 more }
id: optional string

Billing item identifier tag.

maxLength32
account_type: optional string
address: optional string
address2: optional string
balance: optional string
card_expiry_month: optional number
card_expiry_year: optional number
card_number: optional string
city: optional string
company: optional string
country: optional string
created_on: optional string
formatdate-time
device_data: optional string
edited_on: optional string
formatdate-time
enterprise_billing_email: optional string
enterprise_primary_email: optional string
first_name: optional string
is_partner: optional boolean
last_name: optional string
next_bill_date: optional string
formatdate-time
payment_address: optional string
payment_address2: optional string
payment_city: optional string
payment_country: optional string
payment_email: optional string
payment_first_name: optional string
payment_gateway: optional string
payment_last_name: optional string
payment_nonce: optional string
payment_state: optional string
payment_zipcode: optional string
primary_email: optional string
state: optional string
tax_id_type: optional string
telephone: optional string
validation_code: optional string
vat: optional string
zipcode: optional string
ProfileUpdateBillingEmailResponse object { id, account_type, address, 35 more }
id: optional string

Billing item identifier tag.

maxLength32
account_type: optional string
address: optional string
address2: optional string
balance: optional string
card_expiry_month: optional number
card_expiry_year: optional number
card_number: optional string
city: optional string
company: optional string
country: optional string
created_on: optional string
formatdate-time
device_data: optional string
edited_on: optional string
formatdate-time
enterprise_billing_email: optional string
enterprise_primary_email: optional string
first_name: optional string
is_partner: optional boolean
last_name: optional string
next_bill_date: optional string
formatdate-time
payment_address: optional string
payment_address2: optional string
payment_city: optional string
payment_country: optional string
payment_email: optional string
payment_first_name: optional string
payment_gateway: optional string
payment_last_name: optional string
payment_nonce: optional string
payment_state: optional string
payment_zipcode: optional string
primary_email: optional string
state: optional string
tax_id_type: optional string
telephone: optional string
validation_code: optional string
vat: optional string
zipcode: optional string

ProfilesPayment Method

Create Payment Intent for Billing Profile
POST/accounts/{account_id}/billing/profile/payment-method
ModelsExpand Collapse
PaymentMethodCreateResponse object { client_secret, intent_type }
client_secret: optional string

The Stripe client secret for frontend payment method collection.

intent_type: optional string

The type of Stripe intent created.