🚨 This documentation is out of date.
View our New Documentation!
Open Collective Docs
Go back to Open Collective
  • Welcome
  • About
    • Introduction
    • Documentation
    • Terminology
    • Company
    • Pricing
    • Team
    • The Open Collective Way
      • Mission and Values
      • Community Guidelines
    • Hiring
    • Investors
    • Contributing
    • Refund Policy
    • Contact Us
  • Product
    • Features
    • Roadmap
    • Comparison
    • User Profile
    • Dashboard
      • Preview Features
    • Currencies
    • Log-in System
    • Privacy Policy
    • Moderation
    • Security
    • Ledger
      • Individual Transactions
      • Transaction Pairs, Groups & Perspectives
      • Viewing Transactions
      • Exporting Transactions
      • Fiscal Host Ledger Perspective
      • Contributions in the Ledger
      • Added Funds in the Ledger
      • Expenses in the Ledger
      • Ledger Changelog
    • Notifications
    • Two-factor Authentication
    • Activity Log
  • Collectives
    • Collectives FAQ
    • Creating a Collective
    • Quick Start Guide
    • Collective Settings
      • Customize Collective
      • Team
      • Collective Goals & Tiers
      • Expense Policy
      • Data Export
      • Security
      • Integrations
      • Zero Collective Balance
      • Closing a Collective
    • Add Fiscal Host
    • Change Fiscal Host
    • Open Source Collectives
      • Setting up GitHub Sponsors
    • Transparent Budget
    • Expenses
    • Updates & Comms
    • Custom Email
    • Moderation
    • Conversations
    • Events
    • Projects
    • Funding Options
    • Buttons & Banners
    • Connected Collectives
    • Contribution flow
  • Financial Contributors
    • Financial Contributors FAQ
    • Guest contributions
    • Payments
    • Platform Tips
    • Website Badge
    • Receipts
    • Collective to Collective
    • Organizations
      • Organization FAQ
      • Funds
      • Bulk Transfers
      • Gift Cards
      • Sustainer Resources
  • Expenses & Getting Paid
    • Expenses FAQ
    • Submitting Expenses
      • Inviting a third-party to submit an Expense
    • Expense Comments
    • Edit or Download an Expense
    • Receiving payment through Payoneer or Wise
    • Tax Information
  • Fiscal Hosts
    • Fiscal Hosts FAQ
    • Becoming a Fiscal Host
    • Creating a Fiscal Host
    • Organisation Settings
      • Info
      • Customize Profile Page
      • Connect external accounts
      • Accounting Categories
      • Security
      • Manage updates
      • Policies
    • Fiscal Host Dashboard
      • Expenses
      • Financial contributions
      • Pending applications
      • Hosted Collectives
      • Vendors
      • Transaction Report
        • Reports
    • Receiving Money
      • Bank Transfers
      • Credit Card
      • Add Funds Manually
      • Expected Funds
    • Payouts
      • Virtual Card Settings
      • Payouts with PayPal
      • Payouts with Wise
      • Two-factor authentication for payouts
      • Refunds
    • Host Fees
    • Local Tax Support
    • Agreement Templates
  • Independent Collectives
    • About Independent Collectives
    • Create an Independent Collective
      • Migrate from Self-Hosted to Independent Collective
      • Migrate from a Fiscal Host to Independent Collective
    • Independent Collective Setup
    • Independent Collective Management
      • Money coming in: Contributions
      • Money going out: Expenses
    • Close an Independent Collective
  • Contributing
    • Design
      • Design Workflow
      • Design Contribution Guidelines
    • Development
      • Contribution Guide
      • Best Practice Guidelines
      • Bounties
      • Architecture
      • API
        • Members
        • Collectives
        • Events
      • README Integration
      • PayPal
      • TransferWise
      • Post-Donation Redirect
      • Manual Reporting
      • GitHub Permissions
      • Internationalization (i18n) system
      • Testing with Cypress
      • Testing features
        • Conversations
      • Collective's locations
      • Virtual Cards
    • Documentation
      • Resources for documentarians
      • Style guide
      • Suggesting changes
    • Translation
  • Developers
    • OAuth
    • Personal Tokens
Powered by GitBook

Helpful Links

  • Website
  • Blog
  • Contact
  • Slack

â’¸ Open Collective 2024

On this page
  • URL parameters
  • Embed Contribution flow
  • General considerations
  • Embed the default tier (Donate)
  • Embed a specific tier
  • Embed an event ticket

Was this helpful?

Edit on GitHub
Export as PDF
  1. Collectives

Contribution flow

PreviousConnected CollectivesNextFinancial Contributors FAQ

Last updated 5 months ago

Was this helpful?

The contribution flow is how users support a collective on Open Collective. The Contribution flow can be directly accessed via this link: e.g.

Replace 'webpack' with your collective slug to generate your own.

URL parameters

The contribution flow supports many URL parameters to pre-fill the contribution.

Example: .

This link will bring you directly to the profile step of the contribution flow for webpack, with a monthly contribution of $66.66.

name
type
description
default
example

amount

amount

Default contribution amount

&amount=42.42

quantity

integer

Default number of units (for products and tickets only)

1

&quantity=5

interval

interval

The contribution interval (must be supported by the selected tier, if any)

&interval='month'

paymentMethod

string

ID of the payment method to use. Will fallback to another payment method if not available.

contributeAs

string

Slug of the default profile to use to contribute

Logged in user personal profile

email

string

Guest contributions only: The email to use to contribute

&email=test@opencollective.com

name

string

Guest contributions only: The name to use to contribute

&name=John Doe

legalName

string

Guest contributions only: The legal name to use to contribute

&legalName=John Doe

disabledPaymentMethodTypes

comma-separated list

To disable specific payment method types

&disabledPaymentMethodTypes=MANUAL,BANK_TRANSFER

redirect

string

The URL to redirect to after a successful contribution

&redirect=https://www.example.com/thank-you

tags

comma-separated list

Some tags to attach to the contribution

&tags=tag1,tag2

hideSteps

boolean

To hide the steps on top. Will also hide the "previous" button on step payment

hideFAQ

boolean

Embed only: Whether we need to hide the right-column FAQ

false

&hideFAQ=true

hideHeader

boolean

Embed only: Whether we need to hide the contribution flow header

false

&hideHeader=true

backgroundColor

color

Embed only: A custom color to use as the background color of the contribution flow

&backgroundColor=#ff0000

useTheme

boolean

Embed only: Whether to use the collective theme (custom colors)

false

&useTheme=true

shouldRedirectParent

boolean

Embed only: Whether to redirect the parent of the iframe rather than the iframe itself. The iframe needs to have

its sandbox property set to allow-top-navigation for this to work.

totalAmount

alias

Deprecated: Use amount instead

&totalAmount=4200

defaultEmail

alias

Deprecated: Use email instead

defaultName

alias

Deprecated: Use name instead

Embed Contribution flow

To integrate a "Contribute" option directly on your website

The embed contribution flow is a way to integrate Open Collective on your own website. Visitors will be able to contribute directly, by simply providing an email address.

General considerations

  • The widget will look better if it has some space, ideally the full page height & width

Embed the default tier (Donate)

<iframe src="https://opencollective.com/embed/COLLECTIVE_SLUG/donate" style="width: 100%; min-height: 100vh;"></iframe>

Embed a specific tier

To embed a specific tier, you'll need to know its ID. For that, go to your profile page, click on "Contribute" for the tier you want to embed then check the URL. It should look like https://opencollective.com/COLLECTIVE_SLUG/contribute/TIER_SLUG-TIER_ID/checkout

From this URL, you can deduct the embedded one (prefix with embed and removes /checkout):

<iframe src="https://opencollective.com/embed/COLLECTIVE_SLUG/contribute/TIER_SLUG-TIER_ID" style="width: 100%; min-height: 100vh;"></iframe>

Embed an event ticket

Embedding for event tickets uses the same route as regular tiers. you must make sure to remove the parent collective path and to include a slug. The slug can be anything, so if you're not sure feel free to put any value in there. For example, this path:

can be embedded as:

Some parameters can be used to customize the UI. See above

The simplest way to embed the contribution flow is by using the /donate URL (e.g. ). Just replace COLLECTIVE_SLUG by your collective slug below:

https://opencollective.com/webpack/donate
https://opencollective.com/webpack/donate/profile?amount=66.66&interval=month
https://opencollective.com/babel/donate
https://opencollective.com/mautic/events/mautic-conference-europe-4da0de72/order/32898
https://opencollective.com/embed/mautic-conference-europe-4da0de72/contribute/general-access-ticket-32898
URL Parameters
Embedded contribution on the website of an initiative