Handles subscription options, billing cycles, and membership credentials.

Transaction Details - Recurring

Recurring / Membership Management

Variable Requirement Type Possible Values / Example Description Notes
pr_is_recurring Optional boolean yes Flags the transaction as recurring transactions will be on a cadence. Sets recurring transaction flag when yes.
pr_is_initial Optional boolean yes Identifies the transaction as the initial payment for a recurring subscription or installment plan. Intended only for the first transaction in a recurring series. When set to yes, the system applies the ‘init,recurring,cit’ transaction flags. The pr_plan_id field is required when using this parameter, as it is used to determine the appropriate transaction flag handling context.
pr_plan_id Optional integer 123 ID of the selected subscription plan. Required to support Membership Management features.
pr_recurring_amount Optional decimal 25.00 Recurring subscription fee. Only sent with initial subscription sign-ups.
pr_balance Optional decimal 1234.56 Customer’s remaining balance. Only sent with initial subscription sign-ups.
pr_billing_cycle Optional decimal 3 Number of months between recurring charges. '0' means non-recurring. Only sent with initial sign-ups.
pr_months_before_first_billed Optional string 1 Months before first recurring transaction. Only sent with initial sign-ups.
pr_days_before_first_billed Optional string 3 Days before first recurring transaction. Only sent with initial sign-ups.
pr_minutes_before_first_billed Optional integer 0 Minutes before first recurring transaction. Only sent with initial sign-ups.
pr_can_renew Optional string yes Indicates if customer can renew subscription. Defaults to no if omitted.
pt_customer_username Optional/Mandatory string — Customer’s username. Required for Membership Management subscription sign-ups. 1 2
pb_customer_password Optional/Mandatory string — Customer’s password. Required for initial subscription sign-ups. 1
pb_customer_password_confirmation Optional/Mandatory string — Customer’s password confirmation. Must match pb_customer_password. 1

  1. This field is required only for sign-ups that involve password management. They are not necessary when using recurring or installment billing alone. ↩︎ ↩︎ ↩︎

  2. To enable password management sign-ups where customers choose a username and password on the billing page, contact support. For best results, merchants are encouraged to handle username/password selection, validation, and filtering on their own systems before submitting the data. ↩︎