Get data about the currently authenticated user.
Get a list of your subscribers.
| Param | Default | Description |
| ordering | id desc | Order of results returned |
| limit | 10 | Number of results returned (max 100) |
| before_id | All subscribers returned will have an id less than before_id | |
| after_id | All subscribers returned will have an id greater than after_id |
Get a single subscriber.
| Param | Default | Description |
| id | ID of subscriber | |
| Email address of subscriber |
Create a subscriber in the authenticated account.
| Param | Default | Description |
| *required* | Email address | |
| password | auto-generated | Plain-text password |
| first_name | First Name | |
| last_name | Last Name | |
| phone | Phone number | |
| address_1 | Address 1 | |
| address_2 | Address 2 | |
| city | City | |
| country | ISO country code | |
| state | Two letter state abbreviation (ex. CA) | |
| zip | Valid zip code | |
| profile | JSON metadata of profile questions |
Update a subscriber in the authenticated account.
| Param | Default | Description |
| id | *required* | ID of subscriber |
| Email address | ||
| password | Plain-text password | |
| first_name | First Name | |
| last_name | Last Name | |
| phone | Phone number | |
| address_1 | Address 1 | |
| address_2 | Address 2 | |
| city | City | |
| country | ISO country code | |
| state | Two letter state abbreviation (ex. CA) | |
| zip | Valid zip code | |
| profile | JSON metadata of profile questions |
Get all plans in the authenticated account.
| Param | Default | Description |
| enabled | 1 | Show enabled plans only (boolean) |
Get a single plan for authenticated account.
| Param | Default | Description |
| id | *required* | ID of the specified plan |
Update data for a single plan for authenticated account.
| Param | Default | Description |
| id | *required* | ID of the specified plan |
| name | Name of plan | |
| shipping | yes/no | Whether to require shipping |
| enabled | yes/no | Whether to plan is enabled |
| image | URL to plan image | |
| feature_1, feature_2...feature_10 | Plan Features | |
| setup_fee | Setup fee for plan (ex. 10.95) | |
| shopify_product_id | Product ID of Shopify product plan is associated with | |
| shopify_variant_id | Variant ID of Shopify product plan is associated with | |
| shopify_fulfillment | Fulfillment code of Shopify fulfillment provider | |
| sku | Plan SKU | |
| ordering | Order in which plan is shown in relation to other plans | |
| installments | Number of payments made by a single subscriber on this plan | |
| billing_cycle_anchor | Day of the month on which all new subscribers will be billed |
Get a token (Good for 30 seconds) to use to automatically log a subscriber into Paywhirl.
| Param | Default | Description |
| id | *required if email not provided* | ID of the user |
| *required if id not provided* | Email address of the user |