Disclaimer banner cps-icon-v2

This documentation applies to the Legacy platform. If your dashboard matches the screenshot shown here, please refer to the new platform documentation.

Disclaimer banner image
New documentation
Disclaimer banner image

Claim $PayByName Coupon

API POST Fields (in addition to the Main Fields described in the Introduction)

Field Name
Claim $PayByName Coupon
cmd
Descriptionclaim_pbn_coupon
Required?Yes
coupon
DescriptionThe coupon code to redeem.
Required?Yes
Field NameDescriptionRequired?
Claim $PayByName Coupon
cmdclaim_pbn_couponYes
couponThe coupon code to redeem.Yes

API Response

A successful call to this command will give you a result similar to this (JSON):
{
	"error":"ok",
	"result":{"tagid":"abc123","expires":0}
}
The result wil have the following fields:
  • tagid = The new tag ID which can then be claimed.
  • expires = The Unix timestamp of when the tag expires.