Manage program subscription configurations and recurring billing setups.
Summary
Functions
Creates a new subscription.
Creates a new subscription. Raises Marqeta.Error on failure.
Retrieves a subscription by token.
Retrieves a subscription by token. Raises Marqeta.Error on failure.
Lists subscription resources.
Lists subscription resources. Raises Marqeta.Error on failure.
Returns a lazy Stream that auto-paginates subscription resources.
Updates an existing subscription.
Updates an existing subscription. Raises Marqeta.Error on failure.
Functions
@spec create( map(), keyword() ) :: {:ok, map()} | {:error, Marqeta.Error.t()}
Creates a new subscription.
Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.
Creates a new subscription. Raises Marqeta.Error on failure.
@spec get( String.t(), keyword() ) :: {:ok, map()} | {:error, Marqeta.Error.t()}
Retrieves a subscription by token.
Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.
Retrieves a subscription by token. Raises Marqeta.Error on failure.
@spec list( map(), keyword() ) :: {:ok, map()} | {:error, Marqeta.Error.t()}
Lists subscription resources.
Accepts standard Marqeta pagination params:
count, start_index, sort_by, sort_order, fields.
Use stream/2 to lazily iterate all pages automatically.
Lists subscription resources. Raises Marqeta.Error on failure.
@spec stream( map(), keyword() ) :: Enumerable.t()
Returns a lazy Stream that auto-paginates subscription resources.
@spec update(String.t(), map(), keyword()) :: {:ok, map()} | {:error, Marqeta.Error.t()}
Updates an existing subscription.
Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.
Updates an existing subscription. Raises Marqeta.Error on failure.