{"_id":"59a45d2cd12e81000f842f3b","category":{"_id":"59a45d2bd12e81000f842eee","version":"59a45d2bd12e81000f842ee2","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"59a45d2bd12e81000f842ee2","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:12:59.168Z","releaseDate":"2017-08-28T18:12:59.168Z","categories":["59a45d2bd12e81000f842ee3","59a45d2bd12e81000f842ee4","59a45d2bd12e81000f842ee5","59a45d2bd12e81000f842ee6","59a45d2bd12e81000f842ee7","59a45d2bd12e81000f842ee8","59a45d2bd12e81000f842ee9","59a45d2bd12e81000f842eea","59a45d2bd12e81000f842eeb","59a45d2bd12e81000f842eec","59a45d2bd12e81000f842eed","59a45d2bd12e81000f842eee","59a45d2bd12e81000f842eef","59a45d2bd12e81000f842ef0","59a45d2bd12e81000f842ef1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__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":53,"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\": \"`paymentSource`\",\n \"9-1\": \"*object*\",\n \"9-3\": \"Container of [payment-source](doc:payment-source) properties.\",\n \"9-2\": \"See [paymentSource](doc:payment-source).\",\n \"10-0\": \"`chargeInfo`\",\n \"10-2\": \"See [chargeInfo](doc:charge-info).\",\n \"10-3\": \"ID of an existing vaulted shopper.\",\n \"10-1\": \"*object*\",\n \"1-0\": \"`subscriptionId`\",\n \"1-3\": \"\",\n \"1-1\": \"*integer*\",\n \"1-2\": \"BlueSnap identifier for the subscription.\",\n \"4-0\": \"`transactionId`\",\n \"4-1\": \"*integer*\",\n \"4-2\": \"BlueSnap identifier for the transaction.\",\n \"5-0\": \"`transactionDate`\",\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\": \"`softDescriptor`\",\n \"8-1\": \"*string*\",\n \"8-2\": \"Description of the transaction, which appears on the shopper's credit card statement.\",\n \"0-0\": \"`chargeId`\",\n \"0-1\": \"*integer*\",\n \"0-2\": \"BlueSnap identifier for the charge.\",\n \"2-0\": \"`planId`\",\n \"2-1\": \"*integer*\",\n \"2-2\": \"BlueSnap identifier for the billing plan.\",\n \"3-0\": \"`vaultedShopperId`\",\n \"3-1\": \"*integer*\",\n \"3-2\": \"ID of the vaulted shopper.\",\n \"11-0\": \"`processingInfo`\",\n \"11-1\": \"*object*\",\n \"11-2\": \"See [processingInfo](doc:processing-info).\"\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
Property Name
Type
Required
chargeId
integer
BlueSnap identifier for the charge.
subscriptionId
integer
BlueSnap identifier for the subscription.
planId
integer
BlueSnap identifier for the billing plan.
vaultedShopperId
integer
ID of the vaulted shopper.
transactionId
integer
BlueSnap identifier for the transaction.
transactionDate
string
Date (yyyy-mm-dd) of the transaction.
For example: "2017-07-21"
amount
decimal
Charge amount.
softDescriptor
string
Description of the transaction, which appears on the shopper's credit card statement.