API Reference

Billing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Profiles

Get Billing Profile

client.billing.profiles.get(ProfileGetParams { account_id } params, RequestOptionsoptions?): ProfileGetResponse { id, account_type, address, 35 more }

GET/accounts/{account_id}/billing/profile

Create Billing Profile

client.billing.profiles.create(ProfileCreateParams { account_id, address, address2, 17 more } params, RequestOptionsoptions?): ProfileCreateResponse { id, account_type, address, 35 more }

POST/accounts/{account_id}/billing/profile

Update Billing Profile

client.billing.profiles.update(ProfileUpdateParams { account_id, address, address2, 17 more } params, RequestOptionsoptions?): ProfileUpdateResponse { id, account_type, address, 35 more }

PUT/accounts/{account_id}/billing/profile

Delete Billing Profile

client.billing.profiles.delete(ProfileDeleteParams { account_id } params, RequestOptionsoptions?): void

DELETE/accounts/{account_id}/billing/profile

Update Billing Email

client.billing.profiles.updateBillingEmail(ProfileUpdateBillingEmailParams { account_id, billing_email, preferred_locale, secondary_billing_email } params, RequestOptionsoptions?): ProfileUpdateBillingEmailResponse { id, account_type, address, 35 more }

PATCH/accounts/{account_id}/billing/profile

ModelsExpand Collapse

ProfileGetResponse { id, account_type, address, 35 more }

id?: string

Billing item identifier tag.

maxLength32

account_type?: string

address?: string

address2?: string

balance?: string

card_expiry_month?: number

card_expiry_year?: number

card_number?: string

city?: string

company?: string

country?: string

created_on?: string

formatdate-time

device_data?: string

edited_on?: string

formatdate-time

enterprise_billing_email?: string

enterprise_primary_email?: string

first_name?: string

is_partner?: boolean

last_name?: string

next_bill_date?: string

formatdate-time

payment_address?: string

payment_address2?: string

payment_city?: string

payment_country?: string

payment_email?: string

payment_first_name?: string

payment_gateway?: string

payment_last_name?: string

payment_nonce?: string

payment_state?: string

payment_zipcode?: string

primary_email?: string

state?: string

tax_id_type?: string

telephone?: string

validation_code?: string

vat?: string

zipcode?: string

ProfileCreateResponse { id, account_type, address, 35 more }

id?: string

Billing item identifier tag.

maxLength32

account_type?: string

address?: string

address2?: string

balance?: string

card_expiry_month?: number

card_expiry_year?: number

card_number?: string

city?: string

company?: string

country?: string

created_on?: string

formatdate-time

device_data?: string

edited_on?: string

formatdate-time

enterprise_billing_email?: string

enterprise_primary_email?: string

first_name?: string

is_partner?: boolean

last_name?: string

next_bill_date?: string

formatdate-time

payment_address?: string

payment_address2?: string

payment_city?: string

payment_country?: string

payment_email?: string

payment_first_name?: string

payment_gateway?: string

payment_last_name?: string

payment_nonce?: string

payment_state?: string

payment_zipcode?: string

primary_email?: string

state?: string

tax_id_type?: string

telephone?: string

validation_code?: string

vat?: string

zipcode?: string

ProfileUpdateResponse { id, account_type, address, 35 more }

id?: string

Billing item identifier tag.

maxLength32

account_type?: string

address?: string

address2?: string

balance?: string

card_expiry_month?: number

card_expiry_year?: number

card_number?: string

city?: string

company?: string

country?: string

created_on?: string

formatdate-time

device_data?: string

edited_on?: string

formatdate-time

enterprise_billing_email?: string

enterprise_primary_email?: string

first_name?: string

is_partner?: boolean

last_name?: string

next_bill_date?: string

formatdate-time

payment_address?: string

payment_address2?: string

payment_city?: string

payment_country?: string

payment_email?: string

payment_first_name?: string

payment_gateway?: string

payment_last_name?: string

payment_nonce?: string

payment_state?: string

payment_zipcode?: string

primary_email?: string

state?: string

tax_id_type?: string

telephone?: string

validation_code?: string

vat?: string

zipcode?: string

ProfileUpdateBillingEmailResponse { id, account_type, address, 35 more }

id?: string

Billing item identifier tag.

maxLength32

account_type?: string

address?: string

address2?: string

balance?: string

card_expiry_month?: number

card_expiry_year?: number

card_number?: string

city?: string

company?: string

country?: string

created_on?: string

formatdate-time

device_data?: string

edited_on?: string

formatdate-time

enterprise_billing_email?: string

enterprise_primary_email?: string

first_name?: string

is_partner?: boolean

last_name?: string

next_bill_date?: string

formatdate-time

payment_address?: string

payment_address2?: string

payment_city?: string

payment_country?: string

payment_email?: string

payment_first_name?: string

payment_gateway?: string

payment_last_name?: string

payment_nonce?: string

payment_state?: string

payment_zipcode?: string

primary_email?: string

state?: string

tax_id_type?: string

telephone?: string

validation_code?: string

vat?: string

zipcode?: string

ProfilesPayment Method

Create Payment Intent for Billing Profile

client.billing.profiles.paymentMethod.create(PaymentMethodCreateParams { account_id } params, RequestOptionsoptions?): PaymentMethodCreateResponse { client_secret, intent_type }

POST/accounts/{account_id}/billing/profile/payment-method

ModelsExpand Collapse

PaymentMethodCreateResponse { client_secret, intent_type }

client_secret?: string

The Stripe client secret for frontend payment method collection.

intent_type?: string

The type of Stripe intent created.