Create a Plan

1. Plan ID (plan_id)

• Type: string
• Description: An ID that refers to a newly created plan.
• Required: Optional
• Format: Alphanumeric and Special Characters
• Min Length: 3 characters
• Max Length: 191 characters
• Example:
  • mynewplan_1
  • plan_de2c4146 - if PAYARC generated one.
• Note: Users can create a custom plan ID or PAYARC will generate one automatically.

2. Amount (amount)

• Type: integer
• Description: A positive integer in cents representing how much to charge.
• Required: Yes
• Format: Numeric (in cents)
• Min Value: 50
• Max Value: 10,000,000
• Example:
  • 9 would be $0.09
  • 10,000,000 would be $100,000.00

3. Name (name)

• Type: string
• Description: Name of the plan.
• Required: Yes
• Format: Alphanumeric and Special Characters
• Min Length: 3 characters
• Max Length: 50 characters
• Example: mynewplanname

4. Interval (interval)

• Type: string
• Description: The unit of interval for billing a plan.
• Required: Yes
• Format: Alphabetic
• Allowed Values:
  • day
  • month
  • week
  • year

5. Interval Count (interval_count)

• Type: integer
• Description: The frequency of billing.
• Required: Yes
• Format: Numeric
• Specifications: Allowed Values:
  • Days: 1 - 365
  • Months: 1 - 12
  • Weeks: 1 - 52
  • Years: 1
• Note:
  • interval: interval_count(frequency) | what it means?
  • days: 2 | You will be billed every two days.
  • months: 3 | You will be billed every 3 months.
  • weeks: 4 | You will be billed every 4 weeks.
  • years: 1 | You will be billed every 1 year.

6. Trial Period Days (trial_period_days)

• Type: integer
• Description: Number of days of the trial period that a customer is not charged for.
• Required: Optional
• Format: Numeric
• Specifications: Allowed Values: 0 - 365

7. Statement Descriptor (statement_descriptor)

• Type: string
• Description: An arbitrary string to be displayed on a plan.
• Required: Yes
• Format: Alphanumeric and Special Characters
• Min Length: 5 characters
• Max Length: 25 characters
• Example: A1 Company 888-888-8888

8. Plan Description (plan_description)

• Type: string
• Description: An arbitrary string that describes a plan.
• Required: Optional
• Format: Alphanumeric and Special Characters
• **Min​⬤