Did this page help you? Yes No Tell us about it...

Subscription Button Input Reference

The input parameters are a mix of required parameters, as listed in the following table.

Parameter

Description

Required

abandonUrl

Optionally enter the URL where senders should be redirected if they cancel their transaction

accessKey

Your AWS Access Key

Yes

amount

Enter the amount you want to collect for the item

Yes

amazonPaymentsAccountId Your Amazon Payments account ID. This parameter is not used and should not be present if you sign the button using your secret key. For more information, see Using Access Identifiers). Yes

cobrandingStyle

Optionally, set to a cobranding style. Valid values are "logo" or "banner". ("logo" is preferred)

collectShippingAddress

Optionally set to 1 if you want Amazon Payments to return the buyer's shipping address as part of the transaction information

description

Enter a description of the item

Yes

immediateReturn

Optionally set to 1 to skip the final status page in Amazon Payments. Default is 0.

ipnUrl

Optionally type the URL of your host page to which Amazon Payments should send the IPN transaction information

noOfPromotionTransactions

Optionally set to the number of transactions in the promotion period.

Yes, if promotionAmount is not null or zero.

processImmediate

Optionally set to 1 to settle the transaction, otherwise set processImmediate to 0. Default value is 1

promotionAmount

The optional amount you are providing for a promotional price.

recurringFrequency

The billing period (how often Amazon bills the subscriber)

The format is x tag, where tag is either day, week, month, and year, and x is a number that makes sense for tag. For example, 1 month is valid, but 31 month is not.

Yes

recurringStartDate

Optionally enter the start date for the subscription. By default, the subscription will be processed as soon as subscription is created

referenceId

Optionally provide a unique identifies of this transaction for your records.

returnUrl

Optionally enter the URL where buyers should be redirected after they complete the transaction

signature A value calculated using the form parameters. Yes

signatureMethod The signing algorithm, either HmacSHA1 or HmacSHA256. Yes

signatureVersion A value that specifies the signature format. Currently, the only valid value is 2. Yes

subscriptionPeriod

Optionally enter the subscription duration.

The format is x tag, where tag is either day, week, month, and year, and x is a number that makes sense for tag. For example, 1 month is valid, but 31 month is not.

The value forever by itself is also valid.

	Note
	If this parameter is not provided, or the value is `forever`, the subscription will be for an unlimited period.

Subscription buttons have special features to consider. See Working with Subscription Button Advanced Features

For information on using the Amazon Simple Pay to create buttons, see Understanding the Amazon Simple Pay Button Samples.

Subscription Button Well-Formed HTML

Example HTML for a subscription button, signed using the signature version 2 method.

<form 
  action="https://authorize.payments.amazon.com/pba/paypipeline"
  method="POST">
  <input type="hidden" name="immediateReturn"
    value="1" >
  <input type="hidden" name="noOfPromotionTransactions"
    value="2" >
  <input type="hidden" name="recurringStartDate"
    value="1250161950" >
  <input type="hidden" name="collectShippingAddress"
    value="1" >
  <input type="hidden" name="promotionAmount"
    value="USD 1" >
  <input type="hidden" name="accessKey"
    value="YourAccessKeyId" >
  <input type="hidden" name="referenceId"
    value="MyTransaction-001" >
  <input type="hidden" name="recurringFrequency"
    value="1 month" >
  <input type="hidden" name="amount"
    value="USD 10.05" >
  <input type="hidden" name="signature"
    value="L8I/R5inJ3RtGIz/uYvyYlIu1ibDcSlaSn3/IwK6ciA=" >
  <input type="hidden" name="isAutoRenewal"
    value="0" >
  <input type="hidden" name="description"
    value="Daily NYT Delivery" >
  <input type="hidden" name="ipnUrl"
    value="http://yourwebsite.com/instantpaymentnotification" >
  <input type="hidden" name="returnUrl"
    value="http://yourwebsite.com/success" >
  <input type="hidden" name="processImmediate"
    value="0" >
  <input type="hidden" name="cobrandingStyle"
    value="logo" >
  <input type="hidden" name="abandonUrl"
    value="http://yourwebsite.com/cancel" >
  <input type="image"
    src=
"https://authorize.payments-sandbox.amazon.com/pba/images/GMSubscribeWithLogo.png"
    border="0">
  <input type="hidden" name="signatureVersion"
    value="2" >
  <input type="hidden" name="signatureMethod"
    value="HmacSHA256" >
</form>

Document Conventions
Terms of Use

Did this page help you? Yes No Tell us about it...