Payment Methods

List saved payment methods for a customer

GET

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods

x-api-key (header)

OAuth 2.0

Retrieves the payment methods saved on a customer (e.g. cards stored via a card-save link). Pass ?provider= to narrow to a single payment provider.

Required Scope

payment-methods-read

List saved payment methods for a customer › path Parameters

customerId

string · required

The customer ID

List saved payment methods for a customer › query Parameters

provider

string · enum

Filter by payment provider

Enum values:

ONPAY

STRIPE

List saved payment methods for a customer › Responses

200

List of payment methods

PaymentMethodResponse[]

PaymentMethodResponse

id

string · required

Unique identifier of the payment method

Example: 019D1234-ABCD-7000-8000-123456789ABC

customerId

string · required

Customer ID this payment method belongs to

Example: 019CBD16-4BFF-766B-BAD7-2F7C36DC3377

provider

string · enum · required

Payment provider

Enum values:

ONPAY

STRIPE

Example: ONPAY

label

string · required

Human-readable label for the payment method

Example: Dankort •••• 1234

isDefault

boolean · required

Whether this is the default payment method for the customer

Example: false

status

string · enum · required

Current status of the payment method

Enum values:

ACTIVE

EXPIRED

CANCELLED

Example: ACTIVE

createdAt

string · required

When the payment method was created

Example: 2026-03-25T10:30:00.000Z

cardMask

string

Masked card number

Example: 457199XXXXXX1234

cardType

string

Card type as reported by the provider

Example: dankort

expiryMonth

number

Card expiry month

Example: 12

expiryYear

number

Card expiry year

Example: 2029

Apply a payment method to all active subscriptions for a customer

POST

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods/{paymentMethodId}/apply-to-subscriptions

x-api-key (header)

OAuth 2.0

Assigns the specified payment method to all active, trial, and scheduled subscriptions. Overwrites existing card assignments. Excludes PARENT_PAYS subscriptions.

Apply a payment method to all active subscriptions for a customer › path Parameters

customerId

string · required

The customer ID

paymentMethodId

string · required

The payment method ID to apply

Apply a payment method to all active subscriptions for a customer › Request Body

ApplyPaymentMethodToSubscriptionsDto

enableAutomaticBilling

boolean · required

Whether to enable automatic billing on the subscriptions

Apply a payment method to all active subscriptions for a customer › Responses

200

Card applied to subscriptions

No data returned

Cancel a saved card on the payment provider

DELETE

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods/{paymentMethodId}/cancel

x-api-key (header)

OAuth 2.0

Cancels the card subscription on OnPay and marks it as cancelled. This cannot be undone.

Cancel a saved card on the payment provider › path Parameters

customerId

string · required

The customer ID

paymentMethodId

string · required

The payment method ID to cancel

Cancel a saved card on the payment provider › Responses

200

Card cancelled

No data returned

Unassign a payment method from a customer

DELETE

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods/{paymentMethodId}/unassign

x-api-key (header)

OAuth 2.0

Removes the link between the customer and the card. The card stays active on the provider and can be reassigned to another customer.

Unassign a payment method from a customer › path Parameters

customerId

string · required

The customer ID

paymentMethodId

string · required

The payment method ID to unassign

Unassign a payment method from a customer › Responses

200

Payment method unassigned

No data returned

Generate a link for the customer to save a card for future payments

POST

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods/card-save-link

x-api-key (header)

OAuth 2.0

Creates a payment window URL where the customer can enter their card details. The card is saved as a subscription for future charges. Send this URL to your customer.

Generate a link for the customer to save a card for future payments › path Parameters

customerId

string · required

The customer ID

Generate a link for the customer to save a card for future payments › Request Body

CreateCardSaveLinkRequest

provider

string · enum · required

Payment provider to use for saving the card

Enum values:

ONPAY

STRIPE

Example: ONPAY

Generate a link for the customer to save a card for future payments › Responses

Payment link created

PaymentLinkResponse

url

string · required

URL to the payment provider window. Send this to your customer.

Example: https://onpay.io/window/v3/ce8490fa-282e-11f1-a569-11b5d69909e2?k=FFtXYUNXxkh

expiresAt

string · required

When the payment link expires

Example: 2026-03-25T11:30:00.000Z

Set a saved payment method as the customer default

PUT

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods/default/{paymentMethodId}

x-api-key (header)

OAuth 2.0

Marks this card as the default for the customer. The default card is pre-selected when assigning new subscriptions — it does not retroactively change existing subscriptions. Use the apply-to-subscriptions endpoint to update existing subscriptions.

Set a saved payment method as the customer default › path Parameters

customerId

string · required

The customer ID

paymentMethodId

string · required

The payment method ID to set as default

Set a saved payment method as the customer default › Responses

200

Default updated

No data returned

Credit Notes Draft Journal Entries

LedgerBee Public API

Payment Methods

Download schema

List saved payment methods for a customer

GET

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods

x-api-key (header)

OAuth 2.0

Retrieves the payment methods saved on a customer (e.g. cards stored via a card-save link). Pass ?provider= to narrow to a single payment provider.

Required Scope

payment-methods-read

List saved payment methods for a customer › path Parameters

customerId

string · required

The customer ID

List saved payment methods for a customer › query Parameters

provider

string · enum

Filter by payment provider

Enum values:

ONPAY

STRIPE

List saved payment methods for a customer › Responses

200

List of payment methods

PaymentMethodResponse[]

PaymentMethodResponse

id

string · required

Unique identifier of the payment method

Example: 019D1234-ABCD-7000-8000-123456789ABC

customerId

string · required

Customer ID this payment method belongs to

Example: 019CBD16-4BFF-766B-BAD7-2F7C36DC3377

provider

string · enum · required

Payment provider

Enum values:

ONPAY

STRIPE

Example: ONPAY

label

string · required

Human-readable label for the payment method

Example: Dankort •••• 1234

isDefault

boolean · required

Whether this is the default payment method for the customer

Example: false

status

string · enum · required

Current status of the payment method

Enum values:

ACTIVE

EXPIRED

CANCELLED

Example: ACTIVE

createdAt

string · required

When the payment method was created

Example: 2026-03-25T10:30:00.000Z

cardMask

string

Masked card number

Example: 457199XXXXXX1234

cardType

string

Card type as reported by the provider

Example: dankort

expiryMonth

number

Card expiry month

Example: 12

expiryYear

number

Card expiry year

Example: 2029

Apply a payment method to all active subscriptions for a customer

POST

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods/{paymentMethodId}/apply-to-subscriptions

x-api-key (header)

OAuth 2.0

Assigns the specified payment method to all active, trial, and scheduled subscriptions. Overwrites existing card assignments. Excludes PARENT_PAYS subscriptions.

Apply a payment method to all active subscriptions for a customer › path Parameters

customerId

string · required

The customer ID

paymentMethodId

string · required

The payment method ID to apply

Apply a payment method to all active subscriptions for a customer › Request Body

ApplyPaymentMethodToSubscriptionsDto

enableAutomaticBilling

boolean · required

Whether to enable automatic billing on the subscriptions

Apply a payment method to all active subscriptions for a customer › Responses

200

Card applied to subscriptions

No data returned

Cancel a saved card on the payment provider

DELETE

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods/{paymentMethodId}/cancel

x-api-key (header)

OAuth 2.0

Cancels the card subscription on OnPay and marks it as cancelled. This cannot be undone.

Cancel a saved card on the payment provider › path Parameters

customerId

string · required

The customer ID

paymentMethodId

string · required

The payment method ID to cancel

Cancel a saved card on the payment provider › Responses

200

Card cancelled

No data returned

Unassign a payment method from a customer

DELETE

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods/{paymentMethodId}/unassign

x-api-key (header)

OAuth 2.0

Removes the link between the customer and the card. The card stays active on the provider and can be reassigned to another customer.

Unassign a payment method from a customer › path Parameters

customerId

string · required

The customer ID

paymentMethodId

string · required

The payment method ID to unassign

Unassign a payment method from a customer › Responses

200

Payment method unassigned

No data returned

Generate a link for the customer to save a card for future payments

POST

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods/card-save-link

x-api-key (header)

OAuth 2.0

Creates a payment window URL where the customer can enter their card details. The card is saved as a subscription for future charges. Send this URL to your customer.

Generate a link for the customer to save a card for future payments › path Parameters

customerId

string · required

The customer ID

Generate a link for the customer to save a card for future payments › Request Body

CreateCardSaveLinkRequest

provider

string · enum · required

Payment provider to use for saving the card

Enum values:

ONPAY

STRIPE

Example: ONPAY

Generate a link for the customer to save a card for future payments › Responses

Payment link created

PaymentLinkResponse

url

string · required

URL to the payment provider window. Send this to your customer.

Example: https://onpay.io/window/v3/ce8490fa-282e-11f1-a569-11b5d69909e2?k=FFtXYUNXxkh

expiresAt

string · required

When the payment link expires

Example: 2026-03-25T11:30:00.000Z

Set a saved payment method as the customer default

PUT

https://api.ledgerbee.com/api

/v1/customers/{customerId}/payment-methods/default/{paymentMethodId}

x-api-key (header)

OAuth 2.0

Set a saved payment method as the customer default › path Parameters

customerId

string · required

The customer ID

paymentMethodId

string · required

The payment method ID to set as default

Set a saved payment method as the customer default › Responses

200

Default updated

No data returned

Credit Notes Draft Journal Entries