{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"coupon-info","type":"basic","slug":"coupon-info","excerpt":"","body":"###Request\nN/A\n\n\n###Response\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`coupon-id`\",\n \"1-0\": \"`product-owner-id`\",\n \"2-0\": \"`coupon-name`\",\n \"3-0\": \"`coupon-display-name`\",\n \"4-0\": \"`minimal-amount`\",\n \"5-0\": \"`usage-count-limit`\",\n \"6-0\": \"`coupon-effective-date`\",\n \"7-0\": \"`coupon-expiration-date`\",\n \"8-0\": \"`one-per-email`\",\n \"9-0\": \"`apply-recurring-charges`\",\n \"10-0\": \"`coupon-discount-policy`\",\n \"11-0\": \"`coupon-rules`\",\n \"12-0\": \"`coupon-codes-info`\",\n \"0-1\": \"*long*\",\n \"1-1\": \"*long*\",\n \"2-1\": \"*string*\",\n \"3-1\": \"*string*\",\n \"6-1\": \"*string*\",\n \"7-1\": \"*string*\",\n \"10-1\": \"container\",\n \"11-1\": \"container\",\n \"12-1\": \"container\",\n \"4-1\": \"*decimal*\",\n \"5-1\": \"*integer*\",\n \"8-1\": \"*boolean*\",\n \"9-1\": \"*boolean*\",\n \"0-2\": \"ID of the coupon in BlueSnap.\",\n \"2-2\": \"Internal name of the coupon.\",\n \"3-2\": \"Display name of the coupon.\",\n \"4-2\": \"The coupon will be valid only if the order amount is equal to or greater than this amount.\",\n \"5-2\": \"Maximum number of times each coupon code can be used.\",\n \"6-2\": \"Date after which the coupon is valid.\",\n \"7-2\": \"Expiration date of the coupon.\",\n \"8-2\": \"If **true**, this coupon can only be used once per each email address.\",\n \"9-2\": \"If **true**, this coupon is applied to additional recurring charges. If **false**, it is applied only to the initial charge.\",\n \"10-2\": \"Container of [coupon-discount-policy](doc:coupon-discount-policy) properties.\",\n \"11-2\": \"Container of [coupon-rules](doc:coupon-rules) properties.\",\n \"12-2\": \"Container of [coupon-codes-info](doc:coupon-codes-info) properties.\"\n },\n \"cols\": 3,\n \"rows\": 13\n}\n[/block]","updates":[],"order":23,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61a5033cd3c4d201e7b5840f","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"61a5033cd3c4d201e7b583c2","version":"61a5033cd3c4d201e7b5848b","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a5033cd3c4d201e7b583ba","61a5033cd3c4d201e7b583bb","61a5033cd3c4d201e7b583bc","61a5033cd3c4d201e7b583bd","61a5033cd3c4d201e7b583be","61a5033cd3c4d201e7b583bf","61a5033cd3c4d201e7b583c0","61a5033cd3c4d201e7b583c1","61a5033cd3c4d201e7b583c2","61a5033cd3c4d201e7b583c3","61a5033cd3c4d201e7b583c4"],"_id":"61a5033cd3c4d201e7b5848b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"6040037678d626005641a154","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-07-08T14:50:29.944Z","githubsync":"","__v":0}coupon-info
Property Name
Type
Description
coupon-id
long
ID of the coupon in BlueSnap.
product-owner-id
long
coupon-name
string
Internal name of the coupon.
coupon-display-name
string
Display name of the coupon.
minimal-amount
decimal
The coupon will be valid only if the order amount is equal to or greater than this amount.
usage-count-limit
integer
Maximum number of times each coupon code can be used.
coupon-effective-date
string
Date after which the coupon is valid.
coupon-expiration-date
string
Expiration date of the coupon.
one-per-email
boolean
If true, this coupon can only be used once per each email address.
apply-recurring-charges
boolean
If true, this coupon is applied to additional recurring charges. If false, it is applied only to the initial charge.
