Skip to main content
View as Markdown

The StoredPaymentMethod object

The StoredPaymentMethod object.

note

11 of 11 fields on this object have no description yet. Field documentation lives in the SDK types (types/subscription.ts) so it stays in one place — this page is generated from it.

Fields​

FieldTypeDescription
storedPaymentMethodId
REQUIRED		string
merchantId
REQUIRED		string
customerId
REQUIRED		string
customerEmail
REQUIRED		string
tspProvider
REQUIRED		string
type
REQUIRED		string
brand
OPTIONAL		string
expiryMonth
OPTIONAL		number
expiryYear
OPTIONAL		number
isActive
REQUIRED		boolean
metadata
OPTIONAL		Record<string, unknown>

Example​

{
  "storedPaymentMethodId": "storedpaymentmethod_1a2b3c",
  "merchantId": "merchant_1a2b3c",
  "customerId": "customer_1a2b3c",
  "customerEmail": "customer@example.com",
  "tspProvider": "string",
  "type": "string",
  "brand": "string",
  "expiryMonth": 1,
  "isActive": false
}