The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

ApplicationCharge

The ApplicationCharge resource facilitates one-time charges. This type of charge is recommended for apps that aren’t billed on a recurring basis. You can create an application charge by sending a request with the name the charge should appear under, the price your app is charging, and a return URL where Shopify redirects the merchant after the charge is accepted. After you've created the charge, redirect the merchant to the confirmation URL returned by Shopify. If the charge is declined, then Shopify redirects the merchant and provides a notification message that the app charge was declined.

Note

For testing purposes you can include "test": true when creating the charge. This prevents the credit card from being charged. Test shops and demo shops can't be charged.

Was this section helpful?
Anchor to section titled 'The ApplicationCharge resource'

The ApplicationCharge resource

Properties
confirmation_url
->confirmationUrl
The URL where the merchant accepts or declines the application charge.
created_at
->createdAt
The date and time (ISO 8601 format) when the application charge was created.
id
->id
The ID of the application charge.
name
->name
The application charge name.
price
->price
The price of the application charge. The minimum price is 0.50, and maximum price is 10,000.
return_url
The URL where the merchant is redirected after accepting a charge.
status
->status

The status of the application charge. Valid values:

test
->test
Whether the application charge is a test transaction. Valid values:true,null.
updated_at
The date and time (ISO 8601 format) when the charge was last updated.
currency
->price
The currency of the price of the application charge.
Was this section helpful?
{}The ApplicationCharge resource
{
  "confirmation_url": "https://jsmith.myshopify.com/admin/charges/confirm_application_charge?id=1012637313&signature=BAhpBIGeWzw%3D--17779c1efb4688e9cfa653a3245f923b4f1eb140",
  "created_at": "2013-06-27T08:48:27-04:00",
  "id": 675931192,
  "name": "Super Duper Expensive action",
  "price": "100.00",
  "return_url": "http://super-duper.shopifyapps.com",
  "status": "accepted",
  "test": null,
  "updated_at": "2013-06-27T08:48:27-04:00",
  "currency": "USD"
}
Anchor to section titled 'POST request, Creates an application charge'

post
Creates an application charge

appPurchaseOneTimeCreate
Creates an application charge
Anchor to section titled 'Parameters of Creates an application charge'

Parameters

api_version
string
required
Was this section helpful?
Anchor to section titled 'Examples of Creates an application charge'

Examples

Request body
applicationcharge
Application_charge resource
Was this section helpful?
post
/admin/api/2024-10/application_charges.json
Copy
curl -d '{"application_charge":{"name":"Super Duper Expensive action","price":100.0,"return_url":"http://super-duper.shopifyapps.com","test":true}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2024-10/application_charges.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
{}Response
JSON
HTTP/1.1 201 Created
{
  "application_charge": {
    "id": 1017262350,
    "name": "Super Duper Expensive action",
    "api_client_id": 755357713,
    "price": "100.00",
    "status": "pending",
    "return_url": "http://super-duper.shopifyapps.com/",
    "test": true,
    "created_at": "2024-09-19T10:13:00-04:00",
    "updated_at": "2024-09-19T10:13:00-04:00",
    "currency": "USD",
    "charge_type": null,
    "decorated_return_url": "http://super-duper.shopifyapps.com/?charge_id=1017262350",
    "confirmation_url": "https://jsmith.myshopify.com/admin/charges/755357713/1017262350/ApplicationCharge/confirm_application_charge?signature=BAh7BzoHaWRpBA4xojw6EmF1dG9fYWN0aXZhdGVU--2464d6c107837471fc7e579542e7dfa197a95f6d"
  }
}
Anchor to section titled 'GET request, Retrieves a list of application charges'

get
Retrieves a list of application charges

currentAppInstallation
Retrieves a list of application charges
Anchor to section titled 'Parameters of Retrieves a list of application charges'

Parameters

api_version
string
required
fields
A comma-separated list of fields to include in the response.
since_id
Restrict results to after the specified ID.
Was this section helpful?
Anchor to section titled 'Examples of Retrieves a list of application charges'

Examples

Was this section helpful?
get
/admin/api/2024-10/application_charges.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/application_charges.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "application_charges": [
    {
      "id": 556467234,
      "name": "Green theme",
      "api_client_id": 755357713,
      "price": "120.00",
      "status": "accepted",
      "return_url": "http://google.com",
      "test": null,
      "external_id": null,
      "created_at": "2024-09-19T10:10:57-04:00",
      "updated_at": "2024-09-19T10:10:57-04:00",
      "currency": "USD",
      "charge_type": "theme",
      "decorated_return_url": "http://google.com?charge_id=556467234"
    },
    {
      "id": 675931192,
      "name": "iPod Cleaning",
      "api_client_id": 755357713,
      "price": "5.00",
      "status": "accepted",
      "return_url": "http://google.com",
      "test": null,
      "created_at": "2024-09-19T10:10:57-04:00",
      "updated_at": "2024-09-19T10:10:57-04:00",
      "currency": "USD",
      "charge_type": null,
      "decorated_return_url": "http://google.com?charge_id=675931192"
    },
    {
      "id": 1017262346,
      "name": "Create me a logo",
      "api_client_id": 755357713,
      "price": "123.00",
      "status": "accepted",
      "return_url": "http://google.com",
      "test": null,
      "created_at": "2024-09-19T10:10:57-04:00",
      "updated_at": "2024-09-19T10:10:57-04:00",
      "currency": "USD",
      "charge_type": "brokered_service",
      "decorated_return_url": "http://google.com?charge_id=1017262346"
    }
  ]
}
Anchor to section titled 'GET request, Retrieves an application charge'

get
Retrieves an application charge

currentAppInstallation
Retrieves an application charge
Anchor to section titled 'Parameters of Retrieves an application charge'

Parameters

api_version
string
required
application_charge_id
string
required
fields
A comma-separated list of fields to include in the response.
Was this section helpful?
Anchor to section titled 'Examples of Retrieves an application charge'

Examples

Path parameters
applicationchargeid=675931192
string
required
Was this section helpful?
get
/admin/api/2024-10/application_charges/675931192.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/application_charges/675931192.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "application_charge": {
    "id": 675931192,
    "name": "iPod Cleaning",
    "api_client_id": 755357713,
    "price": "5.00",
    "status": "accepted",
    "return_url": "http://google.com",
    "test": null,
    "created_at": "2024-09-19T10:10:57-04:00",
    "updated_at": "2024-09-19T10:10:57-04:00",
    "currency": "USD",
    "charge_type": null,
    "decorated_return_url": "http://google.com?charge_id=675931192"
  }
}