Skip to content

Latest commit

 

History

History
95 lines (79 loc) · 3.7 KB

DOCUMENTATION.md

File metadata and controls

95 lines (79 loc) · 3.7 KB
Raw

Requirements

  1. Charge requires PHP 7.1+
  2. Stripe API >= 2019-10-17

Installation

  1. Copy Charge folder to site/addons
  2. Run php please update:addons
  3. If you're going to use subscriptions, register the webhook with Stripe here. Set it to https://yoursite.com/!/Charge/webhook.

Settings

  • Go to cp/addons/charge/settings and fill in the required fields. Collections is for if you are using Workshop.

  • in charge.yaml

    • charge_collections - which collection(s) you'll be using for the Workshop submission
    • currency - default currency for payments
    • plan & role - when a customer subscribles to a plan, which role(s) should they have. You could use this to have different membership tiers for example.
    • from_email - when the payment failed emails go out, what email account do they come from
    • one_time_payment_email_template & one_time_payment_email_subject - successful one time payment
    • canceled_email_template & canceled_email_subject - when the subscription ends
    • payment_failed_email_template & payment_failed_email_subject - when payment fails
    • upcoming_payment_email_template & upcoming_payment_email_subject - when payment is upcoming
    • subscription_updated_email_template & subscription_updated_email_template - when subscription is changed

  • in your .env file, which MUST NOT be checked in with Git:

Example settings

charge_collections:
  - things
currency: usd
plans_and_roles:
  - 
    plan: associate
    role:
      - dd062758-f56c-4ca5-a381-fe88f9c54517
from_email: [email protected]
one_time_payment_email_template: emails/one_time_payment
canceled_email_template: emails/cancel_subscription
payment_failed_email_template: emails/payment_failed
upcoming_payment_email_template: emails/payment_upcoming
payment_succeeded_email_template: emails/payment_successful

Emails

In the One Time Payment template, you have access to:

  • amount - amount of charge
  • currency - currency the charge was in
  • description - description of charge
  • receipt_url - link to receipt on Stripe

In the upcoming payment template, you have access to:

  • amount
  • currency
  • due_date
  • first_name
  • last_name
  • plan

In the payment succeeded template, you have access to:

  • amount
  • currency
  • due_date
  • first_name
  • last_name
  • plan

In the payment failed template, you have access to:

  • amount
  • attempt_count - how many times they've attempted payment
  • currency
  • due_date
  • first_name
  • last_name
  • next_payment_attempt - when the next payment will be attempted
  • plan

In the updated & deleted subscription template, you have access to:

  • first_name
  • last_name
  • plan
  • subscription_end - when the subscription ends or will be renewed
  • subscription_status - when the next payment will be attempted

Usage

Please note that much of the payment processing now occurs on the front end, so please see the Stripe docs to understand the payment flow.

You have two options, One Time payments or subscriptions