Removes store credit from the order
import { createClient } from '@spree/sdk'
const client = createClient({
baseUrl: 'https://your-store.com',
publishableKey: '<api-key>',
})
const order = await client.orders.removeStoreCredit('or_abc123', {
bearerToken: '<token>',
}){
"id": "or_UkLWZg9DAJ",
"number": "R176406903",
"state": "cart",
"checkout_steps": [
"address",
"delivery",
"payment",
"complete"
],
"token": "o6HCgycDeUUk4qM1xsQcHX3XBynYmZ2eRLC",
"email": "burton_olson@considine.ca",
"special_instructions": null,
"currency": "USD",
"locale": "en",
"item_count": 1,
"state_lock_version": 1,
"shipment_state": null,
"payment_state": null,
"item_total": "10.0",
"display_item_total": "$10.00",
"ship_total": "100.0",
"display_ship_total": "$100.00",
"adjustment_total": "0.0",
"display_adjustment_total": "$0.00",
"promo_total": "0.0",
"display_promo_total": "$0.00",
"tax_total": "0.0",
"display_tax_total": "$0.00",
"included_tax_total": "0.0",
"display_included_tax_total": "$0.00",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"total": "110.0",
"display_total": "$110.00",
"completed_at": null,
"created_at": "2026-03-11T14:46:36.664Z",
"updated_at": "2026-03-11T14:46:36.713Z",
"order_promotions": [],
"line_items": [
{
"id": "li_UkLWZg9DAJ",
"variant_id": "variant_UkLWZg9DAJ",
"quantity": 1,
"currency": "USD",
"name": "Product 127583",
"slug": "product-127583",
"options_text": "",
"price": "10.0",
"display_price": "$10.00",
"total": "10.0",
"display_total": "$10.00",
"adjustment_total": "0.0",
"display_adjustment_total": "$0.00",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"included_tax_total": "0.0",
"display_included_tax_total": "$0.00",
"promo_total": "0.0",
"display_promo_total": "$0.00",
"pre_tax_amount": "10.0",
"display_pre_tax_amount": "$10.00",
"discounted_amount": "10.0",
"display_discounted_amount": "$10.00",
"display_compare_at_amount": "$0.00",
"created_at": "2026-03-11T14:46:36.694Z",
"updated_at": "2026-03-11T14:46:36.694Z",
"compare_at_amount": null,
"thumbnail_url": null,
"option_values": [],
"digital_links": []
}
],
"shipments": [
{
"id": "ship_UkLWZg9DAJ",
"number": "H44612030253",
"state": "pending",
"tracking": "U10000",
"tracking_url": null,
"cost": "100.0",
"display_cost": "$100.00",
"shipped_at": null,
"created_at": "2026-03-11T14:46:36.699Z",
"updated_at": "2026-03-11T14:46:36.711Z",
"shipping_method": {
"id": "shpm_UkLWZg9DAJ",
"name": "UPS Ground",
"code": "UPS_GROUND"
},
"stock_location": {
"id": "sloc_UkLWZg9DAJ",
"state_abbr": "STATE_ABBR_349",
"name": "Melaine Beier",
"address1": "1600 Pennsylvania Ave NW",
"city": "Washington",
"zipcode": "20500",
"country_iso": "US",
"country_name": "United States of America",
"state_text": "STATE_ABBR_349"
},
"shipping_rates": [
{
"id": "shpr_UkLWZg9DAJ",
"shipping_method_id": "shpm_UkLWZg9DAJ",
"name": "UPS Ground",
"selected": true,
"cost": "100.0",
"display_cost": "$100.00",
"shipping_method": {
"id": "shpm_UkLWZg9DAJ",
"name": "UPS Ground",
"code": "UPS_GROUND"
}
}
]
}
],
"payments": [],
"bill_address": {
"id": "addr_EfhxLZ9ck8",
"firstname": "John",
"lastname": "Doe",
"full_name": "John Doe",
"address1": "330 Lovely Street",
"address2": "Northwest",
"city": "Herndon",
"zipcode": "35005",
"phone": "555-555-0199",
"company": "Company",
"country_name": "United States of America",
"country_iso": "US",
"state_text": "STATE_ABBR_351",
"state_abbr": "STATE_ABBR_351",
"quick_checkout": false,
"state_name": "STATE_NAME_351"
},
"ship_address": {
"id": "addr_VqXmZF31wY",
"firstname": "John",
"lastname": "Doe",
"full_name": "John Doe",
"address1": "331 Lovely Street",
"address2": "Northwest",
"city": "Herndon",
"zipcode": "35005",
"phone": "555-555-0199",
"company": "Company",
"country_name": "United States of America",
"country_iso": "US",
"state_text": "STATE_ABBR_352",
"state_abbr": "STATE_ABBR_352",
"quick_checkout": false,
"state_name": "STATE_NAME_352"
},
"payment_methods": []
}Publishable API key for store access
JWT token for authenticated customers
store credit removed
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
import { createClient } from '@spree/sdk'
const client = createClient({
baseUrl: 'https://your-store.com',
publishableKey: '<api-key>',
})
const order = await client.orders.removeStoreCredit('or_abc123', {
bearerToken: '<token>',
}){
"id": "or_UkLWZg9DAJ",
"number": "R176406903",
"state": "cart",
"checkout_steps": [
"address",
"delivery",
"payment",
"complete"
],
"token": "o6HCgycDeUUk4qM1xsQcHX3XBynYmZ2eRLC",
"email": "burton_olson@considine.ca",
"special_instructions": null,
"currency": "USD",
"locale": "en",
"item_count": 1,
"state_lock_version": 1,
"shipment_state": null,
"payment_state": null,
"item_total": "10.0",
"display_item_total": "$10.00",
"ship_total": "100.0",
"display_ship_total": "$100.00",
"adjustment_total": "0.0",
"display_adjustment_total": "$0.00",
"promo_total": "0.0",
"display_promo_total": "$0.00",
"tax_total": "0.0",
"display_tax_total": "$0.00",
"included_tax_total": "0.0",
"display_included_tax_total": "$0.00",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"total": "110.0",
"display_total": "$110.00",
"completed_at": null,
"created_at": "2026-03-11T14:46:36.664Z",
"updated_at": "2026-03-11T14:46:36.713Z",
"order_promotions": [],
"line_items": [
{
"id": "li_UkLWZg9DAJ",
"variant_id": "variant_UkLWZg9DAJ",
"quantity": 1,
"currency": "USD",
"name": "Product 127583",
"slug": "product-127583",
"options_text": "",
"price": "10.0",
"display_price": "$10.00",
"total": "10.0",
"display_total": "$10.00",
"adjustment_total": "0.0",
"display_adjustment_total": "$0.00",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"included_tax_total": "0.0",
"display_included_tax_total": "$0.00",
"promo_total": "0.0",
"display_promo_total": "$0.00",
"pre_tax_amount": "10.0",
"display_pre_tax_amount": "$10.00",
"discounted_amount": "10.0",
"display_discounted_amount": "$10.00",
"display_compare_at_amount": "$0.00",
"created_at": "2026-03-11T14:46:36.694Z",
"updated_at": "2026-03-11T14:46:36.694Z",
"compare_at_amount": null,
"thumbnail_url": null,
"option_values": [],
"digital_links": []
}
],
"shipments": [
{
"id": "ship_UkLWZg9DAJ",
"number": "H44612030253",
"state": "pending",
"tracking": "U10000",
"tracking_url": null,
"cost": "100.0",
"display_cost": "$100.00",
"shipped_at": null,
"created_at": "2026-03-11T14:46:36.699Z",
"updated_at": "2026-03-11T14:46:36.711Z",
"shipping_method": {
"id": "shpm_UkLWZg9DAJ",
"name": "UPS Ground",
"code": "UPS_GROUND"
},
"stock_location": {
"id": "sloc_UkLWZg9DAJ",
"state_abbr": "STATE_ABBR_349",
"name": "Melaine Beier",
"address1": "1600 Pennsylvania Ave NW",
"city": "Washington",
"zipcode": "20500",
"country_iso": "US",
"country_name": "United States of America",
"state_text": "STATE_ABBR_349"
},
"shipping_rates": [
{
"id": "shpr_UkLWZg9DAJ",
"shipping_method_id": "shpm_UkLWZg9DAJ",
"name": "UPS Ground",
"selected": true,
"cost": "100.0",
"display_cost": "$100.00",
"shipping_method": {
"id": "shpm_UkLWZg9DAJ",
"name": "UPS Ground",
"code": "UPS_GROUND"
}
}
]
}
],
"payments": [],
"bill_address": {
"id": "addr_EfhxLZ9ck8",
"firstname": "John",
"lastname": "Doe",
"full_name": "John Doe",
"address1": "330 Lovely Street",
"address2": "Northwest",
"city": "Herndon",
"zipcode": "35005",
"phone": "555-555-0199",
"company": "Company",
"country_name": "United States of America",
"country_iso": "US",
"state_text": "STATE_ABBR_351",
"state_abbr": "STATE_ABBR_351",
"quick_checkout": false,
"state_name": "STATE_NAME_351"
},
"ship_address": {
"id": "addr_VqXmZF31wY",
"firstname": "John",
"lastname": "Doe",
"full_name": "John Doe",
"address1": "331 Lovely Street",
"address2": "Northwest",
"city": "Herndon",
"zipcode": "35005",
"phone": "555-555-0199",
"company": "Company",
"country_name": "United States of America",
"country_iso": "US",
"state_text": "STATE_ABBR_352",
"state_abbr": "STATE_ABBR_352",
"quick_checkout": false,
"state_name": "STATE_NAME_352"
},
"payment_methods": []
}