paymentPlans

Retrieve payment plan

Changed on

Use this method to retrieve information about a payment plan.

To retrieve a payment plan, you need its paymentPlanId. Our gateway returned the paymentPlanId in the response of the Create Payment Plan method.

Note: If you don't have the paymentPlanId, use our List Payment Plans method to search for the payment plan.

Our gateway returns the following information about the payment plan:

  • Name, length, and currency of the plan
  • How often our gateway collects each payment
  • How much our gateway collects for each payment
  • What happens if the merchant updates or deletes the plan
get/processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}
  • Auth
    HTTP bearer

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

paymentPlanIdstring required

Unique identifier that the merchant assigned to the payment plan.

Response

Successful request. Returns the requested payment plan.

paymentPlanIdstring required

Unique identifier that the merchant assigns to the payment plan.

processingTerminalIdstring

Unique identifier of the terminal that the payment plan is assigned to.

namestring required

Name of the payment plan.

descriptionstring

Description of the payment plan.

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

lengthinteger

Number of payments for the payment plan.

To indicate that the payment plan should run indefinitely, send a value of 0.

type'manual' | 'automatic' required

Indicates how the merchant takes the payment from the customer's account.

  • manual - The merchant manually collects payments from the customer. Use the Pay manual subscription method to collect a manual payment.
  • automatic - The terminal automatically collects payments from the customer.
frequency'weekly' | 'fortnightly' | 'monthly' | 'quarterly' | 'yearly' required

Indicates how often the merchant or the terminal collects a payment from the customer.

onUpdate'update' | 'continue' required

Indicates whether any changes that the merchant makes to the payment plan apply to existing subscriptions.

  • update - Changes apply to existing subscriptions.
  • continue - Changes don't apply to existing subscriptions.
onDelete'complete' | 'continue' required

Indicates what happens to existing subscriptions if the merchant deletes the payment plan.

  • complete - Stops existing subscriptions.
  • continue - Continues existing subscriptions.
customFieldNamesstring[]

Array of custom fields that you can use in subscriptions linked to the payment plan.

Changes