* **Get Charge Permission** - GET https://pay-api.amazon.com/:version/chargePermissions/:chargePermissionId * **Update Charge Permission** - PATCH https://pay-api.amazon.com/:version/chargePermissions/:chargePermissionId * **Close Charge Permission** - DELETE https://pay-api.amazon.com/:version/chargePermissions/:chargePermissionId/close

* **Get Charge Permission** - GET https://pay-api.amazon.eu/:version/chargePermissions/:chargePermissionId * **Update Charge Permission** - PATCH https://pay-api.amazon.eu/:version/chargePermissions/:chargePermissionId * **Close Charge Permission** - DELETE https://pay-api.amazon.eu/:version/chargePermissions/:chargePermissionId/close

* **Get Charge Permission** - GET https://pay-api.amazon.jp/:version/chargePermissions/:chargePermissionId * **Update Charge Permission** - PATCH https://pay-api.amazon.jp/:version/chargePermissions/:chargePermissionId * **Close Charge Permission** - DELETE https://pay-api.amazon.jp/:version/chargePermissions/:chargePermissionId/close

* **Get Charge Permission** - GET https://pay-api.amazon.com/:environment/:version/chargePermissions/:chargePermissionId * **Update Charge Permission** - PATCH https://pay-api.amazon.com/:environment/:version/chargePermissions/:chargePermissionId * **Close Charge Permission** - DELETE https://pay-api.amazon.com/:environment/:version/chargePermissions/:chargePermissionId/close

* **Get Charge Permission** - GET https://pay-api.amazon.eu/:environment/:version/chargePermissions/:chargePermissionId * **Update Charge Permission** - PATCH https://pay-api.amazon.eu/:environment/:version/chargePermissions/:chargePermissionId * **Close Charge Permission** - DELETE https://pay-api.amazon.eu/:environment/:version/chargePermissions/:chargePermissionId/close

* **Get Charge Permission** - GET https://pay-api.amazon.jp/:environment/:version/chargePermissions/:chargePermissionId * **Update Charge Permission** - PATCH https://pay-api.amazon.jp/:environment/:version/chargePermissions/:chargePermissionId * **Close Charge Permission** - DELETE https://pay-api.amazon.jp/:environment/:version/chargePermissions/:chargePermissionId/close


curl "https://pay-api.amazon.com/:environment/:version/chargePermissions/:chargePermissionId"

-X GET

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

``` 'YOUR_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'YOUR_REGION_CODE', 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); try { $client = new Amazon\Pay\API\Client($amazonpay_config); $result = $client->getChargePermission('S01-5105180-3221187'); if ($result['status'] === 200) { $response = json_decode($result['response'], true); $chargePermissionState = $response['statusDetails']['state']; } else { // check the error echo 'status=' . $result['status'] . '; response=' . $result['response']; } } catch (Exception $e) { // handle the exception echo $e; } ?> ```

``` using Amazon.Pay.API.Types; using Amazon.Pay.API.WebStore; using Amazon.Pay.API.WebStore.Types; using Amazon.Pay.API.WebStore.ChargePermission; public class Sample { public WebStoreClient InitiateClient() { // set up config var payConfiguration = new ApiConfiguration ( region: Region.YOUR_REGION_CODE, publicKeyId: "YOUR_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_YOUR_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); // init API client var client = new WebStoreClient(payConfiguration); return client; } public void GetChargePermission() { // prepare the request var chargePermissionId = "S01-5105180-3221187"; // send the request ChargePermissionResponse result = client.GetChargePermission(chargePermissionId); // check if API call was successful if (!result.Success) { // handle the API error (use Status field to get the numeric error code) } // do something with the result, for instance: State chargePermissionState = result.StatusDetails.State; DateTime chargePermissionExpiryDate = result.ExpirationTimestamp; Address buyerAddress = result.BillingAddress; } } ```

```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const config = { publicKeyId: 'YOUR_PUBLIC_KEY_ID', privateKey: fs.readFileSync('tst/private.pem'), region: 'YOUR_REGION_CODE', algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const testPayClient = new Client.WebStoreClient(config); const response = testPayClient.getChargePermission('S01-5105180-3221187'); response.then(function (result) { console.log(result.data); }).catch(err => { console.log(err); }); ```

``` 'YOUR_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'YOUR_REGION_CODE', 'sandbox' => true, 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); try { $client = new Amazon\Pay\API\Client($amazonpay_config); $result = $client->getChargePermission('S01-5105180-3221187'); if ($result['status'] === 200) { $response = json_decode($result['response'], true); $chargePermissionState = $response['statusDetails']['state']; } else { // check the error echo 'status=' . $result['status'] . '; response=' . $result['response']; } } catch (Exception $e) { // handle the exception echo $e; } ?> ```

``` using Amazon.Pay.API.Types; using Amazon.Pay.API.WebStore; using Amazon.Pay.API.WebStore.Types; using Amazon.Pay.API.WebStore.ChargePermission; public class Sample { public WebStoreClient InitiateClient() { // set up config var payConfiguration = new ApiConfiguration ( region: Region.YOUR_REGION_CODE, environment: Environment.Sandbox, publicKeyId: "YOUR_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_YOUR_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); // init API client var client = new WebStoreClient(payConfiguration); return client; } public void GetChargePermission() { // prepare the request var chargePermissionId = "S01-5105180-3221187"; // send the request ChargePermissionResponse result = client.GetChargePermission(chargePermissionId); // check if API call was successful if (!result.Success) { // handle the API error (use Status field to get the numeric error code) } // do something with the result, for instance: State chargePermissionState = result.StatusDetails.State; DateTime chargePermissionExpiryDate = result.ExpirationTimestamp; Address buyerAddress = result.BillingAddress; } } ```

```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const config = { publicKeyId: 'YOUR_PUBLIC_KEY_ID', privateKey: fs.readFileSync('tst/private.pem'), region: 'YOUR_REGION_CODE', sandbox: true, algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const testPayClient = new Client.WebStoreClient(config); const response = testPayClient.getChargePermission('S01-5105180-3221187'); response.then(function (result) { console.log(result.data); }).catch(err => { console.log(err); }); ```


curl "https://pay-api.amazon.com/:environment/:version/chargePermissions/:chargePermissionId" \

-X PATCH

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

-d @request_body

``` 'YOUR_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'YOUR_REGION_CODE', 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); $payload = array( 'merchantMetadata' => array( 'merchantReferenceId' => '32-41-323141-32', 'merchantStoreName' => 'AmazonTestStoreFront', 'noteToBuyer' => 'Some Note to buyer', 'customInformation' => '' ) ); $headers = array('x-amz-pay-Idempotency-Key' => uniqid()); try { $client = new Amazon\Pay\API\Client($amazonpay_config); $result = $client->updateChargePermission('S01-5105180-3221187', $payload); if ($result['status'] === 200) { $response = json_decode($result['response'], true); } else { // check the error echo 'status=' . $result['status'] . '; response=' . $result['response']; } } catch (Exception $e) { // handle the exception echo $e; } ?> ```

``` using Amazon.Pay.API.Types; using Amazon.Pay.API.WebStore; using Amazon.Pay.API.WebStore.Types; using Amazon.Pay.API.WebStore.ChargePermission; public class Sample { public WebStoreClient InitiateClient() { // set up config var payConfiguration = new ApiConfiguration ( region: Region.YOUR_REGION_CODE, publicKeyId: "YOUR_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_YOUR_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); // init API client var client = new WebStoreClient(payConfiguration); return client; } public void UpdateChargePermission() { // prepare the request var chargePermissionId = "S01-5105180-3221187"; var request = new UpdateChargePermissionRequest() { MerchantMetadata = { MerchantReferenceId = "32-41-323141-32", MerchantStoreName = "AmazonTestStoreFront", NoteToBuyer = "Some Note to buyer", CustomInformation = "" } }; // send the request ChargePermissionResponse result = client.UpdateChargePermission(chargePermissionId, request); // check if API call was successful if (!result.Success) { // handle the API error (use Status field to get the numeric error code) } // do something with the result, for instance: State chargePermissionState = result.StatusDetails.State; DateTime chargePermissionExpiryDate = result.ExpirationTimestamp; Address buyerAddress = result.BillingAddress; } } ```

``` import com.amazon.pay.api.AmazonPayResponse; import com.amazon.pay.api.PayConfiguration; import com.amazon.pay.api.WebstoreClient; import com.amazon.pay.api.exceptions.AmazonPayClientException; import com.amazon.pay.api.types.Region; import org.json.JSONObject; public void sample() { PayConfiguration payConfiguration = null; try { payConfiguration = new PayConfiguration() .setPublicKeyId("YOUR_PUBLIC_KEY_ID") .setRegion(Region.YOUR_REGION_CODE) .setPrivateKey("YOUR_PRIVATE_KEY".toCharArray()) .setAlgorithm("AMZN-PAY-RSASSA-PSS-V2"); WebstoreClient webstoreClient = new WebstoreClient(payConfiguration); AmazonPayResponse response = null; String chargePermissionId = "S01-5105180-3221187"; JSONObject payload = new JSONObject(); JSONObject merchantMetadata = new JSONObject(); merchantMetadata.put("merchantReferenceId", "32-41-323141-32"); merchantMetadata.put("merchantStoreName", "AmazonTestStoreFront"); merchantMetadata.put("noteToBuyer", "Some note to buyer"); merchantMetadata.put("customInformation", ""); payload.put("merchantMetadata", merchantMetadata); response = webstoreClient.updateChargePermission(chargePermissionId, payload); } catch (AmazonPayClientException e) { e.printStackTrace(); } } ```

```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const uuidv4 = require('uuid/v4'); const config = { publicKeyId: 'YOUR_PUBLIC_KEY_ID', privateKey: fs.readFileSync('tst/private.pem'), region: 'YOUR_REGION_CODE', algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const payload = { merchantMetadata: { merchantReferenceId: "32-41-323141-32", merchantStoreName: "AmazonTestStoreFront", noteToBuyer: "Some Note to buyer", customInformation: "" } } const testPayClient = new Client.WebStoreClient(config); const response = testPayClient.updateChargePermission('S01-5105180-3221187',payload); response.then(function (result) { console.log(result.data); }).catch(err => { console.log(err); }); ```

``` 'YOUR_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'YOUR_REGION_CODE', 'sandbox' => true, 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); $payload = array( 'merchantMetadata' => array( 'merchantReferenceId' => '32-41-323141-32', 'merchantStoreName' => 'AmazonTestStoreFront', 'noteToBuyer' => 'Some Note to buyer', 'customInformation' => '' ) ); $headers = array('x-amz-pay-Idempotency-Key' => uniqid()); try { $client = new Amazon\Pay\API\Client($amazonpay_config); $result = $client->updateChargePermission('S01-5105180-3221187', $payload); if ($result['status'] === 200) { $response = json_decode($result['response'], true); } else { // check the error echo 'status=' . $result['status'] . '; response=' . $result['response']; } } catch (Exception $e) { // handle the exception echo $e; } ?> ```

``` using Amazon.Pay.API.Types; using Amazon.Pay.API.WebStore; using Amazon.Pay.API.WebStore.Types; using Amazon.Pay.API.WebStore.ChargePermission; public class Sample { public WebStoreClient InitiateClient() { // set up config var payConfiguration = new ApiConfiguration ( region: Region.YOUR_REGION_CODE, environment: Environment.Sandbox, publicKeyId: "YOUR_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_YOUR_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); // init API client var client = new WebStoreClient(payConfiguration); return client; } public void UpdateChargePermission() { // prepare the request var chargePermissionId = "S01-5105180-3221187"; var request = new UpdateChargePermissionRequest() { MerchantMetadata = { MerchantReferenceId = "32-41-323141-32", MerchantStoreName = "AmazonTestStoreFront", NoteToBuyer = "Some Note to buyer", CustomInformation = "" } }; // send the request ChargePermissionResponse result = client.UpdateChargePermission(chargePermissionId, request); // check if API call was successful if (!result.Success) { // handle the API error (use Status field to get the numeric error code) } // do something with the result, for instance: State chargePermissionState = result.StatusDetails.State; DateTime chargePermissionExpiryDate = result.ExpirationTimestamp; Address buyerAddress = result.BillingAddress; } } ```

``` import com.amazon.pay.api.AmazonPayResponse; import com.amazon.pay.api.PayConfiguration; import com.amazon.pay.api.WebstoreClient; import com.amazon.pay.api.exceptions.AmazonPayClientException; import com.amazon.pay.api.types.Environment; import com.amazon.pay.api.types.Region; import org.json.JSONObject; public void sample() { PayConfiguration payConfiguration = null; try { payConfiguration = new PayConfiguration() .setPublicKeyId("YOUR_PUBLIC_KEY_ID") .setRegion(Region.YOUR_REGION_CODE) .setPrivateKey("YOUR_PRIVATE_KEY".toCharArray()) .setEnvironment(Environment.SANDBOX) .setAlgorithm("AMZN-PAY-RSASSA-PSS-V2"); WebstoreClient webstoreClient = new WebstoreClient(payConfiguration); AmazonPayResponse response = null; String chargePermissionId = "S01-5105180-3221187"; JSONObject payload = new JSONObject(); JSONObject merchantMetadata = new JSONObject(); merchantMetadata.put("merchantReferenceId", "32-41-323141-32"); merchantMetadata.put("merchantStoreName", "AmazonTestStoreFront"); merchantMetadata.put("noteToBuyer", "Some note to buyer"); merchantMetadata.put("customInformation", ""); payload.put("merchantMetadata", merchantMetadata); response = webstoreClient.updateChargePermission(chargePermissionId, payload); } catch (AmazonPayClientException e) { e.printStackTrace(); } } ```

```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const uuidv4 = require('uuid/v4'); const config = { publicKeyId: 'YOUR_PUBLIC_KEY_ID', privateKey: fs.readFileSync('tst/private.pem'), region: 'YOUR_REGION_CODE', sandbox: true, algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const payload = { merchantMetadata: { merchantReferenceId: "32-41-323141-32", merchantStoreName: "AmazonTestStoreFront", noteToBuyer: "Some Note to buyer", customInformation: "" } } const testPayClient = new Client.WebStoreClient(config); const response = testPayClient.updateChargePermission('S01-5105180-3221187',payload); response.then(function (result) { console.log(result.data); }).catch(err => { console.log(err); }); ```


curl "https://pay-api.amazon.com/:environment/:version/chargePermissions/:chargePermissionId/close" \

-X DELETE

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

-d @request_body

``` 'YOUR_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'YOUR_REGION_CODE', 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); $payload = array( 'closureReason' => 'No more charges required', 'cancelPendingCharges' => false ); try { $client = new Amazon\Pay\API\Client($amazonpay_config); $result = $client->closeChargePermission('S01-5105180-3221187', $payload); if ($result['status'] === 200) { $response = json_decode($result['response'], true); $chargePermissionState = $response['statusDetails']['state']; } else { // check the error echo 'status=' . $result['status'] . '; response=' . $result['response']; } } catch (Exception $e) { // handle the exception echo $e; } ?> ```

``` using Amazon.Pay.API.Types; using Amazon.Pay.API.WebStore; using Amazon.Pay.API.WebStore.Types; using Amazon.Pay.API.WebStore.ChargePermission; public class Sample { public WebStoreClient InitiateClient() { // set up config var payConfiguration = new ApiConfiguration ( region: Region.YOUR_REGION_CODE, publicKeyId: "YOUR_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_YOUR_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); // init API client var client = new WebStoreClient(payConfiguration); return client; } public void CloseChargePermission() { // prepare the request var chargePermissionId = "S01-5105180-3221187"; var request = new CloseChargePermissionRequest("No more charges required"); // send the request ChargePermissionResponse result = client.CloseChargePermission(chargePermissionId, request); // check if API call was successful if (!result.Success) { // handle the API error (use Status field to get the numeric error code) } // do something with the result, for instance: State chargePermissionState = result.StatusDetails.State; } } ```

``` import com.amazon.pay.api.AmazonPayResponse; import com.amazon.pay.api.PayConfiguration; import com.amazon.pay.api.WebstoreClient; import com.amazon.pay.api.exceptions.AmazonPayClientException; import com.amazon.pay.api.types.Region; import org.json.JSONObject; public void sample() { PayConfiguration payConfiguration = null; try { payConfiguration = new PayConfiguration() .setPublicKeyId("YOUR_PUBLIC_KEY_ID") .setRegion(Region.YOUR_REGION_CODE) .setPrivateKey("YOUR_PRIVATE_KEY".toCharArray()) .setAlgorithm("AMZN-PAY-RSASSA-PSS-V2"); WebstoreClient webstoreClient = new WebstoreClient(payConfiguration); AmazonPayResponse response = null; String chargePermissionId = "S01-5105180-3221187"; JSONObject payload = new JSONObject(); payload.put("closureReason", "No more charges required"); payload.put("cancelPendingCharges", false); response = webstoreClient.closeChargePermission(chargePermissionId, payload); } catch (AmazonPayClientException e) { e.printStackTrace(); } } ```

```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const config = { publicKeyId: 'YOUR_PUBLIC_KEY_ID', privateKey: fs.readFileSync('tst/private.pem'), region: 'YOUR_REGION_CODE', algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const payload = { closureReason: "No more charges required", cancelPendingCharges: false } const testPayClient = new Client.WebStoreClient(config); const response = testPayClient.closeChargePermission('S01-5105180-3221187',payload); response.then(function (result) { console.log(result.data); }).catch(err => { console.log(err); }); ```

``` 'YOUR_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'YOUR_REGION_CODE', 'sandbox' => true, 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); $payload = array( 'closureReason' => 'No more charges required', 'cancelPendingCharges' => false ); try { $client = new Amazon\Pay\API\Client($amazonpay_config); $result = $client->closeChargePermission('S01-5105180-3221187', $payload); if ($result['status'] === 200) { $response = json_decode($result['response'], true); $chargePermissionState = $response['statusDetails']['state']; } else { // check the error echo 'status=' . $result['status'] . '; response=' . $result['response']; } } catch (Exception $e) { // handle the exception echo $e; } ?> ```

``` using Amazon.Pay.API.Types; using Amazon.Pay.API.WebStore; using Amazon.Pay.API.WebStore.Types; using Amazon.Pay.API.WebStore.ChargePermission; public class Sample { public WebStoreClient InitiateClient() { // set up config var payConfiguration = new ApiConfiguration ( region: Region.YOUR_REGION_CODE, environment: Environment.Sandbox, publicKeyId: "YOUR_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_YOUR_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); // init API client var client = new WebStoreClient(payConfiguration); return client; } public void CloseChargePermission() { // prepare the request var chargePermissionId = "S01-5105180-3221187"; var request = new CloseChargePermissionRequest("No more charges required"); // send the request ChargePermissionResponse result = client.CloseChargePermission(chargePermissionId, request); // check if API call was successful if (!result.Success) { // handle the API error (use Status field to get the numeric error code) } // do something with the result, for instance: State chargePermissionState = result.StatusDetails.State; } } ```

``` import com.amazon.pay.api.AmazonPayResponse; import com.amazon.pay.api.PayConfiguration; import com.amazon.pay.api.WebstoreClient; import com.amazon.pay.api.exceptions.AmazonPayClientException; import com.amazon.pay.api.types.Environment; import com.amazon.pay.api.types.Region; import org.json.JSONObject; public void sample() { PayConfiguration payConfiguration = null; try { payConfiguration = new PayConfiguration() .setPublicKeyId("YOUR_PUBLIC_KEY_ID") .setRegion(Region.YOUR_REGION_CODE) .setPrivateKey("YOUR_PRIVATE_KEY".toCharArray()) .setEnvironment(Environment.SANDBOX) .setAlgorithm("AMZN-PAY-RSASSA-PSS-V2"); WebstoreClient webstoreClient = new WebstoreClient(payConfiguration); AmazonPayResponse response = null; String chargePermissionId = "S01-5105180-3221187"; JSONObject payload = new JSONObject(); payload.put("closureReason", "No more charges required"); payload.put("cancelPendingCharges", false); response = webstoreClient.closeChargePermission(chargePermissionId, payload); } catch (AmazonPayClientException e) { e.printStackTrace(); } } ```

```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const config = { publicKeyId: 'YOUR_PUBLIC_KEY_ID', privateKey: fs.readFileSync('tst/private.pem'), region: 'YOUR_REGION_CODE', sandbox: true, algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const payload = { closureReason: "No more charges required", cancelPendingCharges: false } const testPayClient = new Client.WebStoreClient(config); const response = testPayClient.closeChargePermission('S01-5105180-3221187',payload); response.then(function (result) { console.log(result.data); }).catch(err => { console.log(err); }); ```

Parameter	Description
chargePermissionId Type: string	Charge Permission identifier This value is returned at the end of a completed Checkout Session
chargePermissionType Type: string	The type of Charge Permission requested Supported values: 'OneTime' - The Charge Permission can only be used for a single order 'Recurring' - The Charge Permission can be used for recurring orders Default value: 'OneTime"
recurringMetadata Type: recurringMetadata	Metadata about how the recurring Charge Permission will be used. Amazon Pay only uses this information to calculate the Charge Permission expiration date and in buyer communication Note that it is still your responsibility to call Create Charge to charge the buyer for each billing cycle
limits Type: limits	Charge Permission transaction limits
releaseEnvironment Type: string	Amazon Pay environment Possible values: live, sandbox
buyer Type: buyer	Details about the buyer, such as their unique identifier, name, and email
shippingAddress Type: address	Shipping address selected by the buyer
billingAddress Type: address	Billing address for payment instrument selected by the buyer
paymentPreferences Type: list<paymentPreference>	List of payment instruments selected by the buyer
merchantMetadata Type: merchantMetadata	Merchant-provided order details
platformId Type: string	Merchant identifier of the Solution Provider (SP) Only SPs should use this field
creationTimestamp Type: dateTime	UTC date and time when the Charge Permssion was created in ISO 8601 format
expirationTimestamp Type: dateTime	UTC date and time when the Charge Permission will expire in ISO 8601 format One-time Charge Permissions expire 180 days after they are confirmed By default, recurring Charge Permissions expire 13 months after they are confirmed. Creating a charge will reset the expiration date to 13 months. If `recurringMetadata.Frequency` is set to a billing cycle longer than 13 months, the expiration date will be extended to the value of `recurringMetadata.Frequency` plus one month
statusDetails Type: statusDetails	State of the Charge Permission object
presentmentCurrency Type: string	The currency that the buyer will be charged in ISO 4217 format. Example: USD See multi-currency integration for more info

Parameter	Description
amountLimit Type: price	Total amount that can be charged using this Charge Permission. For recurring Charge Permission objects, this value is the total amount that can be charged during the current month
amountBalance Type: price	Remaining balance that can be charged using this Charge Permission. For recurring Charge Permission objects, this is the remaining amount that can be charged during the current month

Parameter	Description
frequency Type: frequency	Frequency at which the buyer will be charged using a recurring Charge Permission. You should specify a frequency even if you expect ad hoc charges Possible combinations: Year: 1-3 Month: 1-36 Week: 1-57 Day: 1-1095
amount Type: price	Amount the buyer will be charged for each recurring cycle. Set to null if amount varies

Parameter	Description
unit Type: string	Frequency unit for each billing cycle. For multiple subscriptions, specify the frequency unit for the shortest billing cycle. Only use Variable if you charge the buyer on an irregular cadence, see handling variable cadence Supported values: 'Year', 'Month', 'Week', 'Day', 'Variable'
value Type: string	Number of frequency units per billing cycle. For example, to specify a weekly cycle set `unit` to Week and `value` to 1. You must set `value` to 0 if you're using variable `unit`

Parameter	Description
amount Type: string	Transaction amount
currencyCode Type: string	Transaction currency code in ISO 4217 format Example: USD

Parameter	Description
buyerId Type: string	Unique Amazon Pay buyer identifier Max length: 42 characters/bytes
name Type: string	Buyer name Max length: 50 characters/bytes
email Type: string	Buyer email address Max length: 64 characters/bytes
phoneNumber Type: string	Buyer default billing address phone number Max length: 20 characters/bytes
primeMembershipTypes Type: string	List of buyer Prime memberships. This data is not available for general use

Parameter	Description
paymentDescriptor Type: string	Amazon Pay-provided description for payment instrument selected by the buyer.

Parameter	Description
merchantReferenceId Type: string	External merchant order identifier. The merchant order identifier is shared in buyer communication and in the buyer transaction history on the Amazon Pay website Max length: 256 characters/bytes
merchantStoreName Type: string	Merchant store name. Setting this parameter will override the default value configured in Seller Central (US, EU, JP). The store name is shared in buyer communication and in the buyer transaction history on the Amazon Pay website Max length: 50 characters/bytes
noteToBuyer Type: string	Description of the order that is shared in buyer communication Do not store sensitive data about the buyer or the transaction in this field. Sensitive data includes, but is not limited to: government-issued identification, bank account numbers, or credit card numbers Max length: 255 characters/bytes
customInformation Type: string	Custom information for the order. This data is not shared in any buyer communication Do not store sensitive data about the buyer or the transaction in this field. Sensitive data includes, but is not limited to: government-issued identification, bank account numbers, or credit card numbers Max length: 4,096 characters/bytes

Parameter	Description
state Type: string	Current object state
reasons Type: list<reason>	List of reasons for current state
lastUpdatedTimestamp Type: dateTime	UTC date and time when the state was last updated in ISO 8601 format

Parameter	Description
reasonCode Type: string	Reason code for current state
reasonDescription Type: string	An optional description of the Charge Permission state

State	Description	Reason code
Chargeable	State in which there are no constraints on the Charge Permission and it can be used to charge the buyer Allowed operation(s): GET Charge Permission UPDATE Charge Permission DELETE Charge Permission	-
NonChargeable	State in which there are constraints on the Charge Permission and it can't be used to charge the buyer Allowed operation(s): GET Charge Permission UPDATE Charge Permission DELETE Charge Permission	PaymentMethodInvalid - The previous charge was declined. For Recurring Charge Permissions, follow the steps for handling declines. For one-time Charge Permissions, ask the buyer to select a different payment method PaymentMethodDeleted - The buyer has deleted the selected payment method BillingAddressDeleted - The buyer has deleted the billing address of the selected payment method PaymentMethodExpired - The selected payment method has expired PaymentMethodNotAllowed - The payment method selected by the buyer is not allowed for this Charge Permission PaymentMethodNotSet - There is no payment method associated with charge permission TransactionAmountExceeded - The amount limit for this Charge Permission has been reached or exceeded TransactionCountExceeded - The transaction count limit for this Charge Permission has been reached or exceeded MFAFailed - Buyer did not verify the transaction. Charge cannot be initiated unless buyer verifies the amount on the transaction
Closed	Charge Permission was closed or has expired Allowed operation(s): GET Charge Permission UPDATE Charge Permission (if `chargePermissionType` is OneTime) DELETE Charge Permission	MerchantClosed - You closed the Charge Permission by calling Cancel ChargePermission operation or the Charge Permission was closed because you did not call Complete Checkout Session BuyerClosed - The buyer closed the Charge Permission AmazonCanceled - Amazon closed the Charge Permission AmazonClosed - Amazon closed the Charge Permission because there is no `amountBalance` remaining Expired - The Charge Permission expired after 180 days StopShipmentAtypicalAuth - There are signs of unusual activity that indicate you shouldn’t proceed with fulfilment.

Name	Location	Description
chargePermissionId (required) Type: string	Path Parameter	Charge Permission identifier

HTTP status code	Reason code	Error description
422 UNPROCESSABLE_ENTITY	InvalidChargePermissionStatus	You have tried to modify a Charge Permission that is in a state where it can't be modified