Claim $PayByName Coupon

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

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.