Retrieve payment plan | Payroc

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

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](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/create) method. **Note:** If you don't have the paymentPlanId, use our [List Payment Plans](https://docs.payroc.com/api/schema/repeat-payments/payment-plans/list) 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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

processingTerminalIdstringRequired4-50 characters

Unique identifier that we assigned to the terminal.

paymentPlanIdstringRequired1-48 characters

Unique identifier that the merchant assigned to the payment plan.

Response

Successful request. Returns the requested payment plan.

paymentPlanIdstring1-48 characters

Unique identifier that the merchant assigns to the payment plan.

namestring5-128 characters

Name of the payment plan.

currencyenum

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

Currency of the transaction. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.

typeenumDefaults to automatic

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

manual - The merchant manually collects payments from the customer.
automatic - The terminal automatically collects payments from the customer.

Indicates how the merchant takes the payment from the customer's account. - `manual` - The merchant manually collects payments from the customer. - `automatic` - The terminal automatically collects payments from the customer.

Allowed values:

frequencyenum

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

Allowed values:

onUpdateenumDefaults to continue

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.

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.

Allowed values:

onDeleteenumDefaults to complete

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

complete - Stops existing subscriptions.
continue - Continues existing subscriptions.

Indicates what happens to existing subscriptions if the merchant deletes the payment plan. - `complete` - Stops existing subscriptions. - `continue` - Continues existing subscriptions.

Allowed values:

processingTerminalIdstringRead-only4-50 characters

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

descriptionstring0-128 characters

Description of the payment plan.

lengthinteger>=0Defaults to 0

Number of payments for the payment plan.

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

customFieldNameslist of strings

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

setupOrderobject

recurringOrderobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

500

Internal Server Error

1	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.RepeatPayments.PaymentPlans;
4
5	namespace Usage;
6
7	public class Example
8	{
9	public async Task Do() {
10	var client = new PayrocClient();
11
12	await client.RepeatPayments.PaymentPlans.RetrieveAsync(
13	new RetrievePaymentPlansRequest {
14	ProcessingTerminalId = "1234001",
15	PaymentPlanId = "PlanRef8765"
16	}
17	);
18	}
19
20	}

1	{
2	"paymentPlanId": "PlanRef8765",
3	"name": "Premium Club",
4	"currency": "USD",
5	"type": "automatic",
6	"frequency": "monthly",
7	"onUpdate": "continue",
8	"onDelete": "complete",
9	"processingTerminalId": "1234001",
10	"description": "Monthly Premium Club subscription",
11	"length": 12,
12	"customFieldNames": [
13	"yourCustomField"
14	],
15	"setupOrder": {
16	"amount": 4999,
17	"breakdown": {
18	"subtotal": 4347,
19	"taxes": [
20	{
21	"name": "Sales Tax",
22	"rate": 5
23	}
24	]
25	},
26	"description": "Initial setup fee for Premium Club subscription"
27	},
28	"recurringOrder": {
29	"amount": 4999,
30	"breakdown": {
31	"subtotal": 4347,
32	"taxes": [
33	{
34	"name": "Sales Tax",
35	"rate": 5
36	}
37	]
38	},
39	"description": "Monthly Premium Club subscription"
40	}
41	}