Create Application Charge

POST 
/openapi/2022-01/application_charges

Create a one-time charge for an application.

Request

application/json

Body

Body

application_charge object
Application charge
namestringrequired
The application charge name.
pricestringrequired
The amount of the charge, must match with the APP package setting amount
return_urlstringrequired
Redirect URL after payment
testboolean
Whether it is a test charge
Default value: false

Example

{
  "application_charge": {
    "name": "string",
    "price": "string",
    "return_url": "string",
    "test": false
  }
}

Responses

200

200

application/json

Schema

Schema

idstring
Example: 372212374209312759
application_idstring
Example: Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU
namestring
Example: test
pricestring
Example: 100
confirm_urlstring
Example: https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU/372212374209312759/one-time/confirm?signature=83207d1ad129d5c2ac36bd8b1b6ff8a8
return_urlstring
Example: https://shoplazza.com
statusstring
Example: pending
testboolean
Default value: true
Example: false
created_atstring
Example: 2024-04-23T02:39:05Z
updated_atstring
Example: 2024-04-23T02:39:05Z

Example

{
  "id": "372212374209312759",
  "application_id": "Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU",
  "name": "test",
  "price": "100",
  "confirm_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU/372212374209312759/one-time/confirm?signature=83207d1ad129d5c2ac36bd8b1b6ff8a8",
  "return_url": "https://shoplazza.com",
  "status": "pending",
  "test": false,
  "created_at": "2024-04-23T02:39:05Z",
  "updated_at": "2024-04-23T02:39:05Z"
}

Result

{
    "id": "372212374209312759",
    "application_id": "Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU",
    "name": "test",
    "price": "100",
    "confirm_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU/372212374209312759/one-time/confirm?signature=83207d1ad129d5c2ac36bd8b1b6ff8a8",
    "return_url": "https://shoplazza.com",
    "status": "pending",
    "test": false,
    "created_at": "2024-04-23T02:39:05Z",
    "updated_at": "2024-04-23T02:39:05Z"
}

422

422

application/json

No schema