Customer payment sources

The customer payment source object and its fields

Customer payment sources are association models that link customers to credit cards. During checkout, a logged customer can retrieve their saved cards and use them to pay the order.

The customer payment source object

A customer payment source object is returned as part of the response body of each successful create, list, retrieve, or update API call.

Field

Type

Description

type

string

customer_payment_sources

id

string

The customer payment source unique identifier

links.self

string

The customer payment source endpoint URL

attributes.name

string

Returns the associated payment source's name

attributes.id

string

Unique identifier for the resource (hash).

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add your own identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool or a CRM.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.customer

object

The associated customer.

relationships.payment_source

object

The associated payment source (i.e. credit card).

meta.mode

string

The resource environment (can be one of test or live)