Module: PaypalAPI::Subscriptions::APIs

Included in:

PaypalAPI::Subscriptions, PaypalAPI::Subscriptions

Defined in:

lib/paypal-api/api_collections/subscriptions.rb

Overview

Common methods for PaypalAPI::Subscriptions class and client.subscriptions instance

Instance Method Summary

• #activate(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

  Activate subscription.

• #cancel(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

  Cancel subscription.

• #capture(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

  Capture authorized payment on subscription.

• #create(query: nil, body: nil, headers: nil) ⇒ Response

  Create subscription.

• #revise(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

  Revise plan or quantity of subscription.

• #show(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

  Show subscription details.

• #suspend(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

  Suspend subscription.

• #transactions(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

  List transactions for subscription.

• #update(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

  Update subscription.

Instance Method Details

#activate(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

Activate subscription

Parameters:

• subscription_id (String) —

  Subscripton ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_activate

# File 'lib/paypal-api/api_collections/subscriptions.rb', line 99

def activate(subscription_id, query: nil, body: nil, headers: nil)
  client.post("/v1/billing/subscriptions/#{encode(subscription_id)}/activate", query: query, body: body, headers: headers)
end

#cancel(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

Cancel subscription

Parameters:

• subscription_id (String) —

  Subscripton ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_cancel

# File 'lib/paypal-api/api_collections/subscriptions.rb', line 87

def cancel(subscription_id, query: nil, body: nil, headers: nil)
  client.post("/v1/billing/subscriptions/#{encode(subscription_id)}/cancel", query: query, body: body, headers: headers)
end

#capture(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

Capture authorized payment on subscription

Parameters:

• subscription_id (String) —

  Subscripton ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_capture

# File 'lib/paypal-api/api_collections/subscriptions.rb', line 111

def capture(subscription_id, query: nil, body: nil, headers: nil)
  client.post("/v1/billing/subscriptions/#{encode(subscription_id)}/capture", query: query, body: body, headers: headers)
end

#create(query: nil, body: nil, headers: nil) ⇒ Response

Create subscription

Parameters:

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_create

# File 'lib/paypal-api/api_collections/subscriptions.rb', line 27

def create(query: nil, body: nil, headers: nil)
  client.post("/v1/billing/subscriptions", query: query, body: body, headers: headers)
end

#revise(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

Revise plan or quantity of subscription

Parameters:

• subscription_id (String) —

  Subscripton ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_revise

# File 'lib/paypal-api/api_collections/subscriptions.rb', line 63

def revise(subscription_id, query: nil, body: nil, headers: nil)
  client.post("/v1/billing/subscriptions/#{encode(subscription_id)}/revise", query: query, body: body, headers: headers)
end

#show(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

Show subscription details

Parameters:

• subscription_id (String) —

  Subscripton ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_get

# File 'lib/paypal-api/api_collections/subscriptions.rb', line 39

def show(subscription_id, query: nil, body: nil, headers: nil)
  client.get("/v1/billing/subscriptions/#{encode(subscription_id)}", query: query, body: body, headers: headers)
end

#suspend(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

Suspend subscription

Parameters:

• subscription_id (String) —

  Subscripton ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_suspend

# File 'lib/paypal-api/api_collections/subscriptions.rb', line 75

def suspend(subscription_id, query: nil, body: nil, headers: nil)
  client.post("/v1/billing/subscriptions/#{encode(subscription_id)}/suspend", query: query, body: body, headers: headers)
end

#transactions(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

List transactions for subscription

Parameters:

• subscription_id (String) —

  Subscripton ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_transactions

# File 'lib/paypal-api/api_collections/subscriptions.rb', line 123

def transactions(subscription_id, query: nil, body: nil, headers: nil)
  client.get("/v1/billing/subscriptions/#{encode(subscription_id)}/transactions", query: query, body: body, headers: headers)
end

#update(subscription_id, query: nil, body: nil, headers: nil) ⇒ Response

Update subscription

Parameters:

• subscription_id (String) —

  Subscripton ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_patch

# File 'lib/paypal-api/api_collections/subscriptions.rb', line 51

def update(subscription_id, query: nil, body: nil, headers: nil)
  client.patch("/v1/billing/subscriptions/#{encode(subscription_id)}", query: query, body: body, headers: headers)
end