Payments Object

The Payments Object is created to record Payments on behalf of Members for Memberships.

The Payments Object incorporates the amount paid for a Membership, but also displays the calculated tax, discounts, and refunds.

• _id: String - Unique ID to identify a Payments Object
• created: Datetime - Datetime when the Payment was created in the Join It system.
• updated: Datetime - Datetime when the Payment was last updated.
• status: Number - Status of Payment (Only current value: 100)‍
• total: Number - Payment Total (Amounts are stored in a currency’s smallest unit.For example, to charge 10 USD, provide an amount value of 1000 -- i.e., 1000 cents).‍
• subtotal: Number - Payment Subtotal ($10.00 is represented as 1000).‍
• application_fee_amount: Number - Service Fee that's charged by Join It
• discount_amount: Number - Amount of Discount applied to the Payment
• discount_label: String - User defined label for the Discount
• currency: String - ISO 3-letter code for Currency (e.g. usd, cad, aud, eur, gbp)
• customer_id: String - Stripe Customer ID that's associated with the Payment
• subscription_id: String - Stripe Subscription ID that's associated with the Payment
• member_id: String - Unique ID of the associated Members Object in Join It
• membership_ids: Array - A list of Unique IDs associated with the related Memberships Objects in Join It
• external_id: String - An ID defined by the user (or external system like Stripe) to identify the Payment (most commonly used/required by European Union regulation)
• stripe_invoice_id: String - Stripe Invoice ID associated with this Payment
• organization_id: String - Unique ID of the associated Organizations Object in Join It
• description: String - Description of payment
• channel: String - Channel of payment (possible values: admin, offline, website)
• invoice_pdf: String - Link to hosted PDF
• lines: Array - Array of a Payment's line item objects
• lines.$.amount: Number - Amount associate with line item
• lines.$.description: String - Description associated with line item
• lines.$.quantity: String - Quantity associated with the line item
• lines.$._id: String - Unique ID of the Membership Types Object associated with the line item
• total_tax_amounts: Array - Taxes associate with Payments
• total_tax_amounts.$.amount: Number - Amount of Tax
• total_tax_amounts.$.inclusive: Boolean - Whether tax is calculated inclusive (like VAT) or calculated on top of payment
• total_tax_amounts.$.name: String - User defined Name of Tax (e.g. Sales Tax, VAT, GST)
• total_tax_amounts.$.tax_rate_id: String - ID of the associated Stripe Tax Rate