WHAT_WE_NEED.md

Subscribe a.k.a. Billing Agreement

Table of Contents:

• Payments
  • Payment
  • Sale
  • Authorization
  • Order
  • Capture
  • Refund
• Billing Plans
• Billing Agreements
• Hooks

Payments API Docs

Payment

• Show Payment GET /v1/payments/payment/{payment_id}

Sale

• Show Sale GET /v1/payments/sale/{sale_id}
• Refund Sale POST /v1/payments/sale/{sale_id}/refund

Refund

• Show Refund GET /v1/payments/refund/{refund_id}

Billing Plans API Docs

• Create Billing Plan POST /v1/payments/billing-plans
• List Billing Plans GET /v1/payments/billing-plans
• Update Billing Plan PATCH /v1/payments/billing-plans/{id}
• Show Billing Plan GET /v1/payments/billing-plans/{id}

Billing Agreements API Docs

• Update Billing Agreement PATCH /v1/payments/billing-agreements/{agreement_id}
• Show Billing Agreement GET /v1/payments/billing-agreements/{agreement_id}
• Bill Billing Agreement Balance POST /v1/payments/billing-agreements/{agreement_id}/bill-balance
• Cancel Billing Agreement POST /v1/payments/billing-agreements/{agreement_id}/cancel
• Set Billing Agreement Balance POST /v1/payments/billing-agreements/{agreement_id}/set-balance
• Suspend Billing Agreement POST /v1/payments/billing-agreements/{agreement_id}/suspend
• Reactivate Billing Agreement POST /v1/payments/billing-agreements/{agreement_id}/re-activate
• List Billing Agreement Transactions GET /v1/payments/billing-agreements/{agreement_id}/transactions
• Execute Billing Agreement POST /v1/payments/billing-agreements/{agreement_id}/agreement-execute

Hooks

• BILLING.PLAN.CREATED
• BILLING.PLAN.UPDATED
• BILLING.SUBSCRIPTION.CREATED
• BILLING.SUBSCRIPTION.CANCELLED
• BILLING.SUBSCRIPTION.SUSPENDED
• BILLING.SUBSCRIPTION.RE-ACTIVATED
• PAYMENT.SALE.COMPLETED
• PAYMENT.SALE.DENIED
• PAYMENT.SALE.PENDING
• PAYMENT.SALE.REFUNDED
• PAYMENT.SALE.REVERSED