Mavenseed Documentation
Back to Mavenseed
  • Welcome to Mavenseed 🎉
  • Getting Started
    • Creating your account
      • Connect to Stripe
        • Stripe F.A.Q.
    • Managing your account
      • Managing Your Sites
        • Custom Domains
        • Importing Data
          • Customers with subscriptions
          • Customers with orders
          • Customers with no orders
          • Courses
          • Videos
          • Images
        • Exporting Data
        • Gateways
        • Policies
      • Inviting Collaborators
      • Guest Authors
      • Manage your Subscription
      • Plugin Subscriptions
  • Creating Content
    • Dashboard
    • Posts
      • Quotes
    • Pages
    • Courses
      • Course Stats
      • Chapters: Adding & Editing
      • Lessons
      • Exercises (Assignments)
        • Submitting to an Exercise
      • Quizzes
      • Details
      • Selling Options
      • Course Files
      • Settings
      • Notes
      • Revisions
    • Community
      • Buzzes
    • Downloads
      • Edit
      • Sell
      • Files
    • Live Streams
      • Editing Details
      • Selling Options
      • Editing Media
      • RSVP's
    • Categories
    • Tags
    • Site Search
    • Page Builder
      • Using Templates
    • Media Library
  • Selling Your Content
    • Single Purchases
    • Bundles
    • Memberships
    • Selling FAQ
    • SCA
  • Running your business
    • Customers
      • Received Payments
    • Progress Reports
    • Orders
      • Creating Manual Orders
    • Managing Subscriptions
      • How Subscriptions Work
      • Creating Subscription Plans
      • Editing a Subscription Plan
      • Canceling & or Deleting customers subscription
      • How to: Creating a tiered subscription offering
      • Changing your Maven Subscription Plan
      • Emailing your Subscribers
      • Team Plans
      • Override Plans Page
      • Custom Welcome Page
      • Free Subscriptions
    • Coupons
    • Gift Cards
    • Gift Subscriptions
    • GDPR
    • Selling Merch
  • Managing your site
    • Activity
      • Events List
      • Single Event
      • UTM Campaigns
      • Comments
    • Reports
    • Settings
      • Scripts
      • Links
      • Design
      • Communications
      • Integrations
        • Google Analytics
        • Google Tag Manager
        • Mailchimp
        • Zapier
        • Youtube
        • Helpscout
        • Tree Planting
      • Taxes
        • Stripe
        • Braintree
        • U.S. Sales Tax
        • EU Value Added Tax
      • Forms
        • Contact form
    • Market
      • Social Links
      • Social
      • Comments
      • Reviews
      • Bookmarks
      • Loves
      • Playlists
      • Gamification
      • PayPal ($)
      • Projects ($)
      • Profiles ($)
    • Security
      • Spam
    • Notifications
    • SEO
  • Developers
    • API
      • Coupons
      • Courses
      • Customers
      • Events
      • Lessons
      • Chapters
      • Course Chapters
      • Orders
      • Payments
      • Subscriptions
    • Webhooks
    • Site Customizations
  • Changelog
    • 2023
      • January
    • 2022
      • December 2022
      • November 2022
      • October 2022
      • September 2022
      • August 2022
      • July 2022
      • May 2022
      • April 2022
      • March 2022
      • February 2022
      • January 2022
    • 2021
      • November 2021
      • September 2021
      • August 2021
      • July 2021
      • June 2021
      • May 2021
      • February 2021
      • January 2021
    • 2020
      • November 2020
      • October 2020
      • September 2020
      • August 2020
      • July 2020
      • June 2020
      • May 2020
      • April 2020
  • Beta Accounts
    • Ensuring Subscription Plans are Synced with Stripe
    • Updating your Stripe Product ID
Powered by GitBook
On this page
  • All Payments
  • Show Payment
  • Create Payment
  • Update Payment
  • Delete a Payment

Was this helpful?

Export as PDF
  1. Developers
  2. API

Payments

All Payments

GET https://yoursite.mavenseed.com/api/v1/payments

Retrieve all payments

Path Parameters

Name
Type
Description

page

integer

Results are paginated.

Headers

Name
Type
Description

Authorization

string

Auth token

[
    {
        "id": 1,
        "customer_id": null,
        "currency": "USD",
        "transaction_id": "ch_EbQTtKjku1fMQJ",
        "created_at": "2019-02-26T16:37:51.829-05:00",
        "updated_at": "2019-02-26T16:37:51.829-05:00",
        "payable_type": "Order",
        "payable_id": null,
        "sub_total_cents": 2995,
        "tax_cents": 0,
        "total_cents": 2995,
        "paid": true,
        "attempts": 0,
        "payment_method": "stripe",
        "tax_type": "no_tax",
        "tax_rate": null
    },
    {
        "id": 1744,
        "customer_id": 1972,
        "currency": "USD",
        "transaction_id": "ch_G0HvNO6YQLdvT9",
        "created_at": "2019-10-16T14:35:44.049-04:00",
        "updated_at": "2019-10-16T14:35:44.049-04:00",
        "payable_type": "Subscription",
        "payable_id": 40,
        "sub_total_cents": 2900,
        "tax_cents": 0,
        "total_cents": 2900,
        "paid": true,
        "attempts": 0,
        "payment_method": "stripe",
        "tax_type": "no_tax",
        "tax_rate": null
    }
]

Show Payment

GET https://yoursite.mavenseed.com/api/v1/payments/:id

Retrieve a single payment

Headers

Name
Type
Description

Authorization

string

Auth token

{
    "id": 1745,
    "customer_id": 1973,
    "currency": "USD",
    "transaction_id": "ch_G0JWRJXBLJ0VEF",
    "created_at": "2019-10-16T16:14:47.103-04:00",
    "updated_at": "2019-10-16T16:14:47.103-04:00",
    "payable_type": "Subscription",
    "payable_id": 41,
    "sub_total_cents": 2900,
    "tax_cents": 0,
    "total_cents": 2900,
    "paid": true,
    "attempts": 0,
    "payment_method": "stripe",
    "tax_type": "no_tax",
    "tax_rate": null
}
null

Create Payment

POST https://yoursite.mavenseed.com/api/v1/payments

Create a payment.

Headers

Name
Type
Description

Authorization

string

Auth Token

Request Body

Name
Type
Description

customer_id

integer

ID of customer to attach the payment to

currency

string

Defaults to USD

transaction_id

string

Typically the Stripe charge id

payable_type

string

Subscription, Order

payable_id

integer

ID of the Subscription or Order

sub_total_cents

integer

Sub total in cents

tax_cents

integer

Tax amount in cents

total_cents

integer

Total amount in cents

paid

boolean

Whether or not the payment is paid

attempts

integer

Attempts made to pay this payment

payment_method

integer

0 - stripe, 1 - manual

tax_type

string

0 - no_tax, 1 - sales, 2 - vat

tax_rate

number

tax rate if tax_type is set as vat

{
    "id": 1745,
    "customer_id": 1973,
    "currency": "USD",
    "transaction_id": "ch_G0JWRJXBLJ0VEF",
    "created_at": "2019-10-16T16:14:47.103-04:00",
    "updated_at": "2019-10-16T16:14:47.103-04:00",
    "payable_type": "Subscription",
    "payable_id": 41,
    "sub_total_cents": 2900,
    "tax_cents": 0,
    "total_cents": 2900,
    "paid": true,
    "attempts": 0,
    "payment_method": "stripe",
    "tax_type": "no_tax",
    "tax_rate": null
}

Update Payment

PATCH https://yoursite.mavenseed.com/api/v1/payments/:id

Update a single payment. All of the above properties in create payment are valid.

Headers

Name
Type
Description

Authorization

string

Auth token

{
    "id": 1745,
    "customer_id": 1973,
    "currency": "USD",
    "transaction_id": "ch_G0JWRJXBLJ0VEF",
    "created_at": "2019-10-16T16:14:47.103-04:00",
    "updated_at": "2019-10-16T16:14:47.103-04:00",
    "payable_type": "Subscription",
    "payable_id": 41,
    "sub_total_cents": 2900,
    "tax_cents": 0,
    "total_cents": 2900,
    "paid": true,
    "attempts": 0,
    "payment_method": "stripe",
    "tax_type": "no_tax",
    "tax_rate": null
}

Delete a Payment

DELETE https://yoursite.mavenseed.com/api/v1/payments/:id

Delete a payment.

Headers

Name
Type
Description

Authorization

string

Auth toke

PreviousOrdersNextSubscriptions

Last updated 3 years ago

Was this helpful?