Skip to content

API

Note: This documentation was moved from the Stripe extension and needs updating.

Subscriptions (API3)

When importing subscriptions, all invoice/charges assigned to the subscription will also be imported.

  • Stripe.importallsubscriptions - import all subscriptions for a given payment processor.

    • Parameters:
      • ppid : Use the given Payment Processor ID.
    • Example
      • `drush cvapi Stripe.importallsubscriptions ppid=6
    • Doc

  • Stripe.importsubscriptions - import some subscriptions for a given payment processor

    • Parameters:
      • limit: Numer of elements to import.
      • ppid : Use the given Payment Processor ID.
      • starting_after : Not required, begin after the last subscriber.
    • Example
      • drush cvapi Stripe.importsubscriptions ppid=6 limit=1 starting_after=sub_DDRzfRsxxxx
    • Doc

  • Stripe.importsubscription - import a single subscription for a given payment processor.

    • Parameters:
      • ppid : Use the given Payment Processor ID.
      • subscription : the stripe subscription id
    • Example
      • drush cvapi Stripe.importsubscriptions ppid=6 subscription=sub_DDRzfRsxxxx
    • Doc

Customers (API3)

  • Stripe.importallcustomers - import all customers for a given payment processor.

    • Parameters:
      • ppid : Use the given Payment Processor ID.
    • Example
      • `drush cvapi Stripe.importallcustomers ppid=6
    • Doc

  • Stripe.importcustomers - import some customers for a given payment processor

    • Parameters:
      • limit: Numer of elements to import.
      • ppid : Use the given Payment Processor ID.
      • starting_after : Not required, begin after the last customer.
    • Example
      • drush cvapi Stripe.importcustomers ppid=6 limit=1 starting_after=cus_DDRzfRsxxxx
    • Doc

  • Stripe.importcustomer - import a single customer for a given payment processor.

    • Parameters:
      • ppid : Use the given Payment Processor ID.
      • customer : the stripe customer id
    • Example
      • drush cvapi Stripe.importcustomers ppid=6 customer=cus_DDRzfRsxxxx
    • Doc

Charges (API3)

  • Stripe.importcharge - import a single charge.
    • Parameters:
      • ppid : Use the given Payment Processor ID.
    • Example:
      • drush cvapi Stripe.importcharge ppid=6 charge=ch_DDRzfRsxxxx contact_id=1234
    • Stripe doc