Set the payment method

POST 
/api/v3/package/:package_id/_action/setPayMethod

Valid values for specifying paymethod:

• inv - Generate an invoice for the subscription but do not take an automatic payment
• crd - Credit Card
• ach - ACH/eCheck
• tok - Tokenized payment method

Additionally:

• If you specify crd you must specify the creditcard_id
• If you specify ach you must specify the ach_id
• If you specify tok you must specify the tokenized_id

Request

application/json

Body

paymethod string

Possible values: [inv, crd, ach, tok]

creditcard_id integer
ach_id integer
tokenized_id integer

Responses

200

Action completed successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": true
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...