Retrieve the default Credit Card

curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/account/credit_cards/default \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "1",
    "type": "credit_card",
    "attributes": {
      "cc_type": "visa",
      "last_digits": "1111",
      "month": 12,
      "year": 2026,
      "name": "John Doe",
      "gateway_payment_profile_id": "card_1JqvNB2eZvKYlo2C5OlqLV7S",
      "default": true
    },
    "relationships": {
      "payment_method": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "payment_method",
      "attributes": {
        "type": "Spree::Gateway::StripeGateway",
        "name": "Stripe",
        "description": "Stripe Payments",
        "preferences": {}
      }
    }
  ]
}

GET

api

storefront

account

credit_cards

default

Retrieve the default Credit Card

curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/account/credit_cards/default \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "1",
    "type": "credit_card",
    "attributes": {
      "cc_type": "visa",
      "last_digits": "1111",
      "month": 12,
      "year": 2026,
      "name": "John Doe",
      "gateway_payment_profile_id": "card_1JqvNB2eZvKYlo2C5OlqLV7S",
      "default": true
    },
    "relationships": {
      "payment_method": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "payment_method",
      "attributes": {
        "type": "Spree::Gateway::StripeGateway",
        "name": "Stripe",
        "description": "Stripe Payments",
        "preferences": {}
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

User token to authorize Cart and Checkout requests.

It is required to associate Cart with the User.

Query Parameters

include

string

Specify the related resources you would like to receive in the response body. More Information.

fields[credit_card]

string

Specify the fields you would like returned in the response body. More information.

Response

200 Success - Returns the credit_card object.

data

Credit Card · object

required

Show child attributes

data.id

string

required

Example:

"1"

data.type

string

default:credit_card

required

Example:

"credit_card"

data.attributes

object

required

Show child attributes

data.attributes.cc_type

enum<string>

Available options:

visa,

mastercard,

amex

Example:

"visa"

data.attributes.last_digits

string

Last 4 digits of CC number

Example:

"1111"

data.attributes.month

number

Expiration date month

Example:

12

data.attributes.year

number

Expiration date year

Example:

2026

data.attributes.name

string

Card holder name

Example:

"John Doe"

data.attributes.gateway_payment_profile_id

string

ID of a gateway's payment method

Example:

"card_1JqvNB2eZvKYlo2C5OlqLV7S"

data.attributes.default

boolean

Defines if this is the default CC for a signed in user

Example:

true

data.relationships

object

required

Show child attributes

data.relationships.payment_method

object

Show child attributes

data.relationships.payment_method.data

object

Show child attributes

data.relationships.payment_method.data.id

string

required

data.relationships.payment_method.data.type

string

required

included

Credit Card Includes · object[]

Show child attributes

included.id

string

required

Example:

"1"

included.type

string

default:payment_method

required

included.attributes

object

required

Show child attributes

included.attributes.type

string

Example:

"Spree::Gateway::StripeGateway"

included.attributes.name

string

Example:

"Stripe"

included.attributes.description

string | null

Example:

"Stripe Payments"

included.attributes.preferences

object

Remove a Credit Card

List all Orders

⌘I

API basics

Tutorials

Storefront API

Platform API

Retrieve the default Credit Card

Authorizations

Query Parameters

Response