{"_id":"59a45d467ee621000fc9d412","category":{"_id":"59a45d447ee621000fc9d3c4","version":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-28T19:25:37.058Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":55,"body":"###Request\nN/A\n\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Description\",\n    \"9-0\": \"`payment-source`\",\n    \"9-1\": \"container\",\n    \"9-3\": \"Container of [payment-source](doc:payment-source) properties.\",\n    \"9-2\": \"Container of [payment-source](doc:payment-source) properties.\",\n    \"10-0\": \"`charge-info`\",\n    \"10-2\": \"Container of [charge-info](doc:charge-info) properties.\",\n    \"10-3\": \"ID of an existing vaulted shopper.\",\n    \"10-1\": \"container\",\n    \"1-0\": \"`subscription-id`\",\n    \"1-3\": \"\",\n    \"1-1\": \"*integer*\",\n    \"1-2\": \"BlueSnap identifier for the subscription.\",\n    \"4-0\": \"`transaction-id`\",\n    \"4-1\": \"*integer*\",\n    \"4-2\": \"BlueSnap identifier for the transaction.\",\n    \"5-0\": \"`transaction-date`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Date (yyyy-mm-dd) of the transaction.\\n\\nFor example: `\\\"2017-07-21\\\"`\",\n    \"6-0\": \"`amount`\",\n    \"6-1\": \"*decimal*\",\n    \"6-2\": \"Charge amount.\",\n    \"7-0\": \"`currency`\",\n    \"7-2\": \"Currency code (ISO 4217) of the charge. See [Currency codes](/v1.0/docs/currency-codes).\",\n    \"7-1\": \"*string*\",\n    \"8-0\": \"`soft-descriptor`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Description of the transaction, which appears on the shopper's credit card statement.\",\n    \"0-0\": \"`charge-id`\",\n    \"0-1\": \"*integer*\",\n    \"0-2\": \"BlueSnap identifier for the charge.\",\n    \"2-0\": \"`plan-id`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"BlueSnap identifier for the billing plan.\",\n    \"3-0\": \"`vaulted-shopper-id`\",\n    \"3-1\": \"*integer*\",\n    \"3-2\": \"ID of the vaulted shopper.\",\n    \"11-0\": \"`processing-info`\",\n    \"11-1\": \"container\",\n    \"11-2\": \"Container of [processing-info](doc:processing-info) properties.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","excerpt":"Contains information about a specific recurring subscription charge","slug":"charge","type":"basic","title":"charge"}

charge

Contains information about a specific recurring subscription charge

Request

N/A

Response

Property Name
Type
Required

charge-id

integer

BlueSnap identifier for the charge.

subscription-id

integer

BlueSnap identifier for the subscription.

plan-id

integer

BlueSnap identifier for the billing plan.

vaulted-shopper-id

integer

ID of the vaulted shopper.

transaction-id

integer

BlueSnap identifier for the transaction.

transaction-date

string

Date (yyyy-mm-dd) of the transaction.

For example: "2017-07-21"

amount

decimal

Charge amount.

currency

string

Currency code (ISO 4217) of the charge. See Currency codes.

soft-descriptor

string

Description of the transaction, which appears on the shopper's credit card statement.

payment-source

container

Container of payment-source properties.

charge-info

container

Container of charge-info properties.

processing-info

container

Container of processing-info properties.