Page tree
Skip to end of metadata
Go to start of metadata

Get /get_credit_card

Provide the credit card details

Provide the details from the credit card configured as the billing method for the SalesSeek licenses.

The pricing model is based on the amount of SalesSeek users (licenses consumed) per month.

Request URL

https://{client_id}.salesseek.net/api/get_credit_card  

Response Type

Response content type: Subscription_Details(JSON)

ModelExample of Response

 

 

Subscription_Details (JSON) {

credit_card (Credit_Card): Includes all the information related to the configured credit card,

subscription (Subscription): Includes all details about the subscription to this SalesSeek account and all its users

success (boolean): true or false if the configured payment method is valid

}

Credit_Card (JSON) {

country_code_numeric (int): the unique country ID (from the standard ISO_Country_Codes )

expiration_month (int): 2-digits number for the card expiration month starting on 01 (January), formatted as MM

expiration_year (boolean): : 4-digits number for the card expiration year, formatted as YYYY

extended_address(int): text for the address 2nd line (optional),

first_name(boolean): card holder's first name, as specified on the card,

hide_number(number): the 16 digits card number hiding the first 12 (with stars) for security reasons,

last_name(number): card holder's last name, as specified on the card,

locality(string): name of the locality for the billing address: city, town, village, etc

postal_code(string): billing address post code,

region(string): region of the billing address, may be a state, province, etc

street_address(string): street of the billing address, including the house number,

type(string): type of card automatically provided by the payment verification

}

Subscription (JSON) {

billing_amount(number): the billing amount (in USD) excluding VAT, it will be purely the amount of users x license price

has_expired(boolean): true or false if this subscription has expired (due to any issue on the billing method)

is_eec_country (boolean): true if the country from the billing address is member of the EEC (*)

num_payable_users(int): amount of SalesSeek users within this current client,

used_within_eec(boolean): just in case the is_eec_country is set to false, this field will be true if the billing should apply the EEC conditions (ie: including VAT)

vat_percentage(number): number representing the percentage of VAT to be applied,

vat_value(number): the actual amount (in USD) to be charged as VAT

}

 

{
	credit_card: {
		country_code_numeric: "826"
		expiration_month: "07"
		expiration_year: "2020"
		extended_address: null
		first_name: "Christine"
		hide_number: "************1111"
		last_name: "Mrown"
		locality: "London"
		postal_code: "W1 5LD"
		region: "London"
		street_address: "221B Baker Street"
		type: "Visa"
	}
	subscription: {
		billing_amount: 1440
		has_expired: false
		is_eec_country: true
		num_payable_users: 30
		used_within_eec: false
		vat_percentage: 20
		vat_value: 288
	}
	success: true
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-Details about the subscription based on this credit cardCredit card subscription

 

 


 

 

POST /new_credit_card

Creates a new credit_card 

Creates a new credit card and returns the resulting element 

Request URL

https://{client_id}.salesseek.net/api/new_credit_card

Request Body
{
	number: 4111111111111111,
	cvv: 444,
	month: 07,
	year: 2020,
	first_name: Christine,
	last_name: Mrown,
	street_address: 221B Baker Street,
	locality: London,
	region: London,
	postal_code: W1 5LD,
	country_code_numeric: 826,
	used_within_eec: false,
	is_eec_country: true
 }

 

Response Type

Response content type: JSON

ModelExample of Response

Subscription_Details (JSON) {

credit_card (Credit_Card): Includes all the information related to the configured credit card,

subscription (Subscription): Includes all details about the subscription to this SalesSeek account and all its users

success (boolean): true or false if the configured payment method is valid

}

Credit_Card (JSON) {

country_code_numeric (int): the unique country ID (from the standard ISO_Country_Codes )

expiration_month (int): 2-digits number for the card expiration month starting on 01 (January), formatted as MM

expiration_year (boolean): : 4-digits number for the card expiration year, formatted as YYYY

extended_address(int): text for the address 2nd line (optional),

first_name(boolean): card holder's first name, as specified on the card,

hide_number(number): the 16 digits card number hiding the first 12 (with stars) for security reasons,

last_name(number): card holder's last name, as specified on the card,

locality(string): name of the locality for the billing address: city, town, village, etc

postal_code(string): billing address post code,

region(string): region of the billing address, may be a state, province, etc

street_address(string): street of the billing address, including the house number,

type(string): type of card automatically provided by the payment verification

}

Subscription (JSON) {

billing_amount(number): the billing amount (in USD) excluding VAT, it will be purely the amount of users x license price

has_expired(boolean): true or false if this subscription has expired (due to any issue on the billing method)

is_eec_country (boolean): true if the country from the billing address is member of the EEC (*)

num_payable_users(int): amount of SalesSeek users within this current client,

used_within_eec(boolean): just in case the is_eec_country is set to false, this field will be true if the billing should apply the EEC conditions (ie: including VAT)

vat_percentage(number): number representing the percentage of VAT to be applied,

vat_value(number): the actual amount (in USD) to be charged as VAT

}

{
	credit_card: {
		country_code_numeric: "826"
		expiration_month: "07"
		expiration_year: "2020"
		extended_address: null
		first_name: "Christine"
		hide_number: "************1111"
		last_name: "Mrown"
		locality: "London"
		postal_code: "W1 5LD"
		region: "London"
		street_address: "221B Baker Street"
		type: "Visa"
	}
	subscription: {
		billing_amount: 1440
		has_expired: false
		is_eec_country: true
		num_payable_users: 30
		used_within_eec: false
		vat_percentage: 20
		vat_value: 288
	}
	success: true
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-The credit-card subscription created after the successful requestJSON

 


 

Get /delete_credit_card

Removes credit-card details from SalesSeek

Removes all details about the credit card and associated billing address from SalesSeek

Request URL

https://{client_id}.salesseek.net/api/delete_credit_card  

Response Type

Response content type: Subscription_Details(JSON)

ModelExample of Response

 

 

Subscription (JSON) {

billing_amount(number): the billing amount (in USD) excluding VAT, it will be purely the amount of users x license price

has_expired(boolean): true or false if this subscription has expired (due to any issue on the billing method)

is_eec_country (boolean): true if the country from the billing address is member of the EEC (*)

num_payable_users(int): amount of SalesSeek users within this current client,

used_within_eec(boolean): just in case the is_eec_country is set to false, this field will be true if the billing should apply the EEC conditions (ie: including VAT)

vat_percentage(number): number representing the percentage of VAT to be applied,

vat_value(number): the actual amount (in USD) to be charged as VAT

}

 

{
	subscription: {
		billing_amount: 1440
		has_expired: false
		is_eec_country: true
		num_payable_users: 30
		used_within_eec: false
		vat_percentage: 20
		vat_value: 288
	}
	success: false
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-Details about the subscription after removing the credit card detailsSubscription

 

 


 

POST /update_credit_card

Updates credit-card details 

updates credit card details

Request URL

https://{client_id}.salesseek.net/api/update_credit_card

Request Body
{
	number: 4111111111111111,
	cvv: 444,
	month: 07,
	year: 2020,
	first_name: Christine,
	last_name: Mrown,
	street_address: 221B Baker Street,
	locality: London,
	region: London,
	postal_code: W1 5LD,
	country_code_numeric: 826,
	used_within_eec: false,
	is_eec_country: true
 }

 

Response Type

Response content type: JSON

ModelExample of Response

Subscription_Details (JSON) {

credit_card (Credit_Card): Includes all the information related to the configured credit card,

subscription (Subscription): Includes all details about the subscription to this SalesSeek account and all its users

success (boolean): true or false if the configured payment method is valid

}

Credit_Card (JSON) {

country_code_numeric (int): the unique country ID (from the standard ISO_Country_Codes )

expiration_month (int): 2-digits number for the card expiration month starting on 01 (January), formatted as MM

expiration_year (boolean): : 4-digits number for the card expiration year, formatted as YYYY

extended_address(int): text for the address 2nd line (optional),

first_name(boolean): card holder's first name, as specified on the card,

hide_number(number): the 16 digits card number hiding the first 12 (with stars) for security reasons,

last_name(number): card holder's last name, as specified on the card,

locality(string): name of the locality for the billing address: city, town, village, etc

postal_code(string): billing address post code,

region(string): region of the billing address, may be a state, province, etc

street_address(string): street of the billing address, including the house number,

type(string): type of card automatically provided by the payment verification

}

Subscription (JSON) {

billing_amount(number): the billing amount (in USD) excluding VAT, it will be purely the amount of users x license price

has_expired(boolean): true or false if this subscription has expired (due to any issue on the billing method)

is_eec_country (boolean): true if the country from the billing address is member of the EEC (*)

num_payable_users(int): amount of SalesSeek users within this current client,

used_within_eec(boolean): just in case the is_eec_country is set to false, this field will be true if the billing should apply the EEC conditions (ie: including VAT)

vat_percentage(number): number representing the percentage of VAT to be applied,

vat_value(number): the actual amount (in USD) to be charged as VAT

}

{
	credit_card: {
		country_code_numeric: "826"
		expiration_month: "07"
		expiration_year: "2020"
		extended_address: null
		first_name: "Christine"
		hide_number: "************1111"
		last_name: "Mrown"
		locality: "London"
		postal_code: "W1 5LD"
		region: "London"
		street_address: "221B Baker Street"
		type: "Visa"
	}
	subscription: {
		billing_amount: 1440
		has_expired: false
		is_eec_country: true
		num_payable_users: 30
		used_within_eec: false
		vat_percentage: 20
		vat_value: 288
	}
	success: true
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-The credit-card subscription updated after the successful requestJSON
  • No labels