Skip to main content
Anchor to PaymentMandateResource

PaymentMandateResource

object

Requires read_payment_mandate access scope or read_customer_payment_methods access scope.

A payment mandate with resource information, representing the permission the owner of the payment instrument gives to the merchant to debit it for specific resources (e.g., Order, Subscriptions).

Anchor to FieldsFields

Anchor to idid
•ID!
non-null

The unique ID of the payment mandate. Matches the corresponding CustomerPaymentMethod.id token, so partners can identify which payment method to use for a given mandate scope (e.g., SUBSCRIPTIONS).

Anchor to resourceIdresourceId
•ID

The ID of the resource that this payment method was created for.

Anchor to resourceTyperesourceType
•MandateResourceType

The resource type that this payment method was created for (e.g., Order, Subscriptions).

Was this section helpful?