GoCardlessClient.Resources.Subscriptions (GoCardlessClient v2.0.0)

GoCardlessClient Subscriptions API.

Subscriptions automatically create payments on a recurring schedule.

Example

{:ok, sub} = GoCardlessClient.Resources.Subscriptions.create(client, %{
  amount: 2500,
  currency: "GBP",
  name: "Premium Monthly",
  interval_unit: "monthly",
  interval: 1,
  day_of_month: 1,
  links: %{mandate: "MD123"}
})

Summary

Functions

cancel(client, id, params \\ %{}, opts \\ [])

Cancels a subscription. No further payments will be created.

collect_all(client, params \\ %{}, opts \\ [])

Eagerly collects all subscriptions into a list.

create(client, params, opts \\ [])

Creates a subscription on a mandate with a recurring schedule.

get(client, id, opts \\ [])

Retrieves a single subscription by ID.

list(client, params \\ %{}, opts \\ [])

Returns a page of subscriptions with optional filters.

pause(client, id, params \\ %{}, opts \\ [])

Pauses a subscription for a given number of cycles. Pass %{pause_cycles: n} as params.

resume(client, id, params \\ %{}, opts \\ [])

Resumes a paused subscription.

stream(client, params \\ %{}, opts \\ [])

Returns a lazy Stream over all pages of subscriptions.

update(client, id, params, opts \\ [])

Updates a subscription's amount, name, or payment_reference.

Functions

cancel(client, id, params \\ %{}, opts \\ [])

@spec cancel(GoCardlessClient.Client.t(), String.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Cancels a subscription. No further payments will be created.

collect_all(client, params \\ %{}, opts \\ [])

@spec collect_all(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, [map()]}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Eagerly collects all subscriptions into a list.

create(client, params, opts \\ [])

@spec create(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Creates a subscription on a mandate with a recurring schedule.

get(client, id, opts \\ [])

@spec get(GoCardlessClient.Client.t(), String.t(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Retrieves a single subscription by ID.

list(client, params \\ %{}, opts \\ [])

@spec list(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, %{items: [map()], meta: map()}}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Returns a page of subscriptions with optional filters.

pause(client, id, params \\ %{}, opts \\ [])

@spec pause(GoCardlessClient.Client.t(), String.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Pauses a subscription for a given number of cycles. Pass %{pause_cycles: n} as params.

resume(client, id, params \\ %{}, opts \\ [])

@spec resume(GoCardlessClient.Client.t(), String.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Resumes a paused subscription.

stream(client, params \\ %{}, opts \\ [])

@spec stream(GoCardlessClient.Client.t(), map(), keyword()) :: Enumerable.t()

Returns a lazy Stream over all pages of subscriptions.

update(client, id, params, opts \\ [])

@spec update(GoCardlessClient.Client.t(), String.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Updates a subscription's amount, name, or payment_reference.