Add Store Credit | BigCommerce Developer Center

Applies any available store credit to a checkout. As on the storefront, all available store credit will be used (up to the value of the order) and no amount need be specified.

Note

Substitute your storefront domain for yourstore.example.com.

The Send a Test Request feature is not currently supported for this endpoint.

This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Applies any available store credit to a checkout. As on the storefront, all available store credit will be used (up to the value of the order) and no amount need be specified. > #### Note > * Substitute your storefront domain for `yourstore.example.com`. > * The Send a Test Request feature is not currently supported for this endpoint. > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Path parameters

checkoutIdstringRequired

Response

Returns Checkout Object.

1	import requests
2
3	url = "https://your_store.example.com/api/storefront/checkouts/checkoutId/store-credit"
4
5	response = requests.post(url)
6
7	print(response.json())