Conekta.Subscriptions (Conekta v1.2.0)

Copy Markdown View Source

Functions for managing customer subscriptions.

Endpoint: https://api.conekta.io/customers/{customer_id}/subscription

Summary

Functions

Cancel a customer's subscription

Create a subscription for a customer Conekta Documentation

Get a customer's subscription Conekta Documentation

Pause a customer's subscription

Resume a paused subscription

Update a customer's subscription Conekta Documentation

Functions

cancel(customer_id)

Cancel a customer's subscription

Method: POST

Conekta.Subscriptions.cancel(customer_id)
# => {:ok, %Conekta.SubscriptionResponse{}}

create(customer_id, subscription)

Create a subscription for a customer Conekta Documentation

Method: POST

Conekta.Subscriptions.create(customer_id, %Conekta.SubscriptionRequest{plan_id: "plan_123"})
# => {:ok, %Conekta.SubscriptionResponse{}}

get(customer_id)

Get a customer's subscription Conekta Documentation

Method: GET

Conekta.Subscriptions.get(customer_id)
# => {:ok, %Conekta.SubscriptionResponse{}}

pause(customer_id)

Pause a customer's subscription

Method: POST

Conekta.Subscriptions.pause(customer_id)
# => {:ok, %Conekta.SubscriptionResponse{}}

resume(customer_id)

Resume a paused subscription

Method: POST

Conekta.Subscriptions.resume(customer_id)
# => {:ok, %Conekta.SubscriptionResponse{}}

update(customer_id, subscription)

Update a customer's subscription Conekta Documentation

Method: PUT

Conekta.Subscriptions.update(customer_id, %Conekta.SubscriptionRequest{plan_id: "new_plan"})
# => {:ok, %Conekta.SubscriptionResponse{}}